Changeset 33717

Timestamp:

08/23/2015 06:07:41 PM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Add a description and example to the hook docs for the navigation_markup_template filter, introduced in [33714].

Since the value of the filter is passed through sprintf() it's important to note that any filtered output needs to contain the expected specifiers.

See #31315.

File:

• trunk/src/wp-includes/link-template.php (modified) (1 diff)

trunk/src/wp-includes/link-template.php

@@ -2427 +2427 @@
          * Filter 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.
+         * @param string $template The default template.
+         * @param string $class    The class passed by the calling function.
          * @return string Navigation template.
          */