On this page
get_the_posts_navigation( array $args = array() ): string
Returns the navigation to next/previous set of posts, when applicable.
Parameters
$argsarray Optional-
Default posts navigation arguments.
prev_textstringAnchor text to display in the previous posts link.
Default 'Older posts'.next_textstringAnchor text to display in the next posts link.
Default 'Newer posts'.screen_reader_textstringScreen reader text for the nav element.
Default 'Posts navigation'.aria_labelstringARIA label text for the nav element. Default'Posts'.classstringCustom 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;
}
Related
Uses
| Uses | Description |
|---|---|
| _navigation_markup() wp-includes/link-template.php | Wraps passed links in navigational markup. |
| get_previous_posts_link() wp-includes/link-template.php | Retrieves the previous posts page link. |
| get_next_posts_link() wp-includes/link-template.php | Retrieves the next posts page link. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| wp_parse_args() wp-includes/functions.php | Merges user defined arguments into defaults array. |
Used By
| Used By | Description |
|---|---|
| the_posts_navigation() wp-includes/link-template.php | Displays the navigation to next/previous set of posts, when applicable. |
Changelog
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_the_posts_navigation