get_the_posts_navigation( array $args = array() )
Returns the navigation to next/previous set of posts, when applicable.
Parameters
- $args
-
(Optional) Default posts navigation arguments. <br>
- 'prev_text'
(string) Anchor text to display in the previous posts link.<br> Default 'Older posts'.<br> - 'next_text'
(string) Anchor text to display in the next posts link.<br> Default 'Newer posts'.<br> - 'screen_reader_text'
(string) Screen reader text for the nav element.<br> Default 'Posts navigation'.<br> - 'aria_label'
(string) ARIA label text for the nav element. Default 'Posts'.<br> - 'class'
(string) Custom class for the nav element. Default 'posts-navigation'.<br>
Default value: array()
- 'prev_text'
Return
(string) Markup for posts links.
Source
File: wp-includes/link-template.php
function get_the_posts_navigation( $args = array() ) {
$navigation = '';
// Don't print empty markup if there's only one page.
if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
$args = wp_parse_args( $args, array(
'prev_text' => __( 'Older posts' ),
'next_text' => __( 'Newer posts' ),
'screen_reader_text' => __( 'Posts navigation' ),
) );
$next_link = get_previous_posts_link( $args['next_text'] );
$prev_link = get_next_posts_link( $args['prev_text'] );
if ( $prev_link ) {
$navigation .= '<div class="nav-previous">' . $prev_link . '</div>';
}
if ( $next_link ) {
$navigation .= '<div class="nav-next">' . $next_link . '</div>';
}
$navigation = _navigation_markup( $navigation, 'posts-navigation', $args['screen_reader_text'] );
}
return $navigation;
}
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Added the class parameter. |
| 5.3.0 | Added the aria_label parameter. |
| 4.1.0 | Introduced. |