The previous post in the sequence.
An object for silent failure, if there is no previous post.
Gets the previous post in the set of siblings for this post as defined by the query in the $args parameter. Hierarchical post types also respond to a “mode” parameter, to further control what the siblings actually are:
- flat – the siblings will be the entire set of posts of the same type flattened first. This would be useful to step through an outline structure of pages, for example.
- cousin – the siblings will be all posts of this type at the same depth as this post.
- sibling (default) – the siblings are the immediate siblings of this post.
An arguments array or string to specify the query, with the following defaults:
- orderby – “menu_order” (hierarchical), “post_date” (non-hierarchical)
- order – “asc” (hierarchical), “desc” (non-hierarchical)
This method also supports these additional arguments:
- mode: sibling | flat | cousin – the sibing mode, see method description – default “sibling”
- loop: true | false, or 1 | 0 – whether to loop back around to the last post if this is the first post in the sequence – default false