_navigation_markup( string $links, string $css_class = 'posts-navigation', string $screen_reader_text = '', string $aria_label = '' ): string
- Since
- 4.1.0, 5.3.0
- Source
wp-includes/link-template.php:3033
Compatibility
- WordPress
- since 5.3.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$linksstring- Navigational links.
$css_classstringoptional- Custom class for the nav element.
Default 'posts-navigation'.Default:'posts-navigation' $screen_reader_textstringoptional- Screen reader text for the nav element.
Default 'Posts navigation'.Default:'' $aria_labelstringoptional- ARIA label for the nav element.
Defaults to the value of$screen_reader_text.Default:''
Return value
string- Navigation template tag.
Performance profile
How much work a call to _navigation_markup() 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
- Trivial
- Scaling
- Constant
- Instructions
- 32–37
- Plugin surface
- 1 hook
- Called by
- 5
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 37.
Third-party callbacks on 'navigation_markup_template' run inside this call, and their cost is not bounded by anything here.
5 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, 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 _navigation_markup() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!empty($screen_reader_text) | 32–33 | apply_filters(), sanitize_html_class(), esc_html(), esc_attr(), sprintf() |
empty($screen_reader_text) | 36–37 | __(), apply_filters(), sanitize_html_class(), esc_html(), esc_attr(), sprintf() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 37 instructions, 32–37 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while _navigation_markup() runs, in this order:
- apply_filters( navigation_markup_template )filterline 3064 (+31 into the body)
Filters the navigation markup template.
Uses · 5
- __()Retrieves the translation of $text.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- sanitize_html_class()Sanitizes an HTML classname to ensure it only contains valid characters.
- esc_html()Escaping for HTML blocks.
- esc_attr()Escaping for HTML attributes.
Used by · 5
- get_the_comments_navigation()Retrieves navigation to next/previous set of comments, when applicable.
- get_the_comments_pagination()Retrieves a paginated navigation to next/previous set of comments, when applicable.
- get_the_post_navigation()Retrieves the navigation to next/previous post, when applicable.
- get_the_posts_navigation()Returns the navigation to next/previous set of posts, when applicable.
- get_the_posts_pagination()Retrieves a paginated navigation to next/previous set of posts, when applicable.
Source code
function _navigation_markup( $links, $css_class = 'posts-navigation', $screen_reader_text = '', $aria_label = '' ) { if ( empty( $screen_reader_text ) ) { $screen_reader_text = /* translators: Hidden accessibility text. */ __( 'Posts navigation' ); } if ( empty( $aria_label ) ) { $aria_label = $screen_reader_text; } $template = ' <nav class="navigation %1$s" aria-label="%4$s"> <h2 class="screen-reader-text">%2$s</h2> <div class="nav-links">%3$s</div> </nav>'; /** * Filters the navigation markup template. * * Note: The filtered template HTML must contain specifiers for the navigation * class (%1$s), the screen-reader-text value (%2$s), placement of the navigation * links (%3$s), and ARIA label text if screen-reader-text does not fit that (%4$s): * * <nav class="navigation %1$s" aria-label="%4$s"> * <h2 class="screen-reader-text">%2$s</h2> * <div class="nav-links">%3$s</div> * </nav> * * @since 4.4.0 * * @param string $template The default template. * @param string $css_class The class passed by the calling function. */ $template = apply_filters( 'navigation_markup_template', $template, $css_class ); return sprintf( $template, sanitize_html_class( $css_class ), esc_html( $screen_reader_text ), $links, esc_attr( $aria_label ) );}Changelog
Introduced in 4.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
aria_label parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.