get_the_posts_navigation( array $args = array() ): string
Returns the navigation to next/previous set of posts, when applicable.
Parameters
-
$args
array Optional -
Default posts navigation arguments.
prev_text
stringAnchor text to display in the previous posts link.
Default 'Older posts'.next_text
stringAnchor text to display in the next posts link.
Default 'Newer posts'.screen_reader_text
stringScreen reader text for the nav element.
Default 'Posts navigation'.aria_label
stringARIA label text for the nav element. Default'Posts'
.class
stringCustom class for the nav element. Default'posts-navigation'
.
Default:
array()
Return
string Markup for posts links.
Source
File: wp-includes/link-template.php
.
View all references
function get_the_posts_navigation( $args = array() ) {
global $wp_query;
$navigation = '';
// Don't print empty markup if there's only one page.
if ( $wp_query->max_num_pages > 1 ) {
// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
$args['aria_label'] = $args['screen_reader_text'];
}
$args = wp_parse_args(
$args,
array(
'prev_text' => __( 'Older posts' ),
'next_text' => __( 'Newer posts' ),
'screen_reader_text' => __( 'Posts navigation' ),
'aria_label' => __( 'Posts' ),
'class' => '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, $args['class'], $args['screen_reader_text'], $args['aria_label'] );
}
return $navigation;
}
Changelog
Version | Description |
---|---|
5.5.0 | Added the class parameter. |
5.3.0 | Added the aria_label parameter. |
4.1.0 | Introduced. |