_navigation_markup
Wraps passed links in navigational markup.
Description
(string) _navigation_markup( (string) $links, (string) $class = 'posts-navigation', (string) $screen_reader_text = '' );
Returns (string)
Navigation template tag.
Parameters (3)
- 0. $links (string)
- Navigational links.
- 1. $class — Optional. (string) =>
'posts-navigation'
- Custom class for nav element. Default: posts-navigation..
- 2. $screen_reader_text — Optional. (string) =>
''
- Screen reader text for nav element. Default: Posts navigation..
Usage
if ( !function_exists( '_navigation_markup' ) ) { require_once ABSPATH . WPINC . '/link-template.php'; } // Navigational links. $links = ''; // Optional. Custom class for nav element. Default: 'posts-navigation'. $class = 'posts-navigation'; // Optional. Screen reader text for nav element. Default: 'Posts navigation'. $screen_reader_text = ''; // NOTICE! Understand what this does before running. $result = _navigation_markup($links, $class, $screen_reader_text);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/link-template.php
- function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '' ) {
- if ( empty( $screen_reader_text ) ) {
- $screen_reader_text = __( 'Posts navigation' );
- }
- $template = '
- <nav class="navigation %1$s" role="navigation">
- <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), and placement of the
- * navigation links (%3$s):
- *
- * <nav class="navigation %1$s" role="navigation">
- * <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 $class The class passed by the calling function.
- * @return string Navigation template.
- */
- $template = apply_filters( 'navigation_markup_template', $template, $class );
- return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links );
- }