_navigation_markup() – Wraps passed links in navigational markup.

You appear to be a bot. Output may be restricted

Description

Wraps passed links in navigational markup.

Usage

$string = _navigation_markup( $links, $class, $screen_reader_text, $aria_label );

Parameters

$links
( string ) required – Navigational links.
$class
( string ) optional default: posts-navigation – Optional. Custom class for the nav element. Default 'posts-navigation'.
$screen_reader_text
( string ) optional – Optional. Screen reader text for the nav element. Default 'Posts navigation'.
$aria_label
( string ) optional – Optional. ARIA label for the nav element. Defaults to the value of `$screen_reader_text`.

Returns

string Navigation template tag.

Source

File name: wordpress/wp-includes/link-template.php
Lines:

1 to 36 of 36
function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '', $aria_label = '' ) {
  if ( empty( $screen_reader_text ) ) {
    $screen_reader_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 $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, esc_html( $aria_label ) );
}
 

 View on GitHub View on Trac