get_the_comments_navigation( array $args = array() ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Default comments navigation arguments.Default: array()

• $prev_textstringdefault: 'Older comments'

  Anchor text to display in the previous comments link.

• $next_textstringdefault: 'Newer comments'

  Anchor text to display in the next comments link.

• $screen_reader_textstringdefault: 'Comments navigation'

  Screen reader text for the nav element.

• $aria_labelstringdefault: 'Comments'

  ARIA label text for the nav element.

• $classstringdefault: 'comment-navigation'

  Custom class for the nav element.

Return value

string

Markup for comments links.

Performance profile

How much work a call to get_the_comments_navigation() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

7–69

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 69.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()one call below get_the_comments_navigation()
• hookthird-party callbacksapply_filters()one call below get_the_comments_navigation()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_the_comments_navigation() can have, taken from its control-flow graph on PHP 8.5.

Uses · 6

• get_comment_pages_count()Calculates the total number of comment pages.
• wp_parse_args()Merges user defined arguments into defaults array.
• __()Retrieves the translation of $text.
• get_previous_comments_link()Retrieves the link to the previous comments page.
• get_next_comments_link()Retrieves the link to the next comments page.
• _navigation_markup()Wraps passed links in navigational markup.

Used by · 1

• the_comments_navigation()Displays navigation to next/previous set of comments, when applicable.

Source code

View on Trac ↗View on GitHub ↗

3317function get_the_comments_navigation( $args = array() ) {3318	$navigation = '';3319 3320	// Are there comments to navigate through?3321	if ( get_comment_pages_count() > 1 ) {3322		// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.3323		if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {3324			$args['aria_label'] = $args['screen_reader_text'];3325		}3326 3327		$args = wp_parse_args(3328			$args,3329			array(3330				'prev_text'          => __( 'Older comments' ),3331				'next_text'          => __( 'Newer comments' ),3332				'screen_reader_text' => __( 'Comments navigation' ),3333				'aria_label'         => __( 'Comments' ),3334				'class'              => 'comment-navigation',3335			)3336		);3337 3338		$prev_link = get_previous_comments_link( $args['prev_text'] );3339		$next_link = get_next_comments_link( $args['next_text'] );3340 3341		if ( $prev_link ) {3342			$navigation .= '<div class="nav-previous">' . $prev_link . '</div>';3343		}3344 3345		if ( $next_link ) {3346			$navigation .= '<div class="nav-next">' . $next_link . '</div>';3347		}3348 3349		$navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] );3350	}3351 3352	return $navigation;3353}

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.