_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

  1. if ( !function_exists( '_navigation_markup' ) ) { 
  2.     require_once ABSPATH . WPINC . '/link-template.php'; 
  3. } 
  4.   
  5. // Navigational links. 
  6. $links = ''; 
  7.   
  8. // Optional. Custom class for nav element. Default: 'posts-navigation'. 
  9. $class = 'posts-navigation'; 
  10.   
  11. // Optional. Screen reader text for nav element. Default: 'Posts navigation'. 
  12. $screen_reader_text = ''; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = _navigation_markup($links, $class, $screen_reader_text); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/link-template.php  
  1. function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader_text = '' ) { 
  2.     if ( empty( $screen_reader_text ) ) { 
  3.         $screen_reader_text = __( 'Posts navigation' ); 
  4.     } 
  5.  
  6.     $template = ' 
  7.     <nav class="navigation %1$s" role="navigation"> 
  8.         <h2 class="screen-reader-text">%2$s</h2> 
  9.         <div class="nav-links">%3$s</div> 
  10.     </nav>'; 
  11.  
  12.     /** 
  13.      * Filters the navigation markup template. 
  14.      * 
  15.      * Note: The filtered template HTML must contain specifiers for the navigation 
  16.      * class (%1$s), the screen-reader-text value (%2$s), and placement of the 
  17.      * navigation links (%3$s): 
  18.      * 
  19.      *     <nav class="navigation %1$s" role="navigation"> 
  20.      *         <h2 class="screen-reader-text">%2$s</h2> 
  21.      *         <div class="nav-links">%3$s</div> 
  22.      *     </nav> 
  23.      * 
  24.      * @since 4.4.0 
  25.      * 
  26.      * @param string $template The default template. 
  27.      * @param string $class    The class passed by the calling function. 
  28.      * @return string Navigation template. 
  29.      */ 
  30.     $template = apply_filters( 'navigation_markup_template', $template, $class ); 
  31.  
  32.     return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links ); 
  33. }