From 83476bb77f9b5ada9691178bf6ba4d46cdf17bc2 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Sun, 23 Aug 2015 18:07:41 +0000
Subject: [PATCH] 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@33717 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/link-template.php | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/src/wp-includes/link-template.php b/src/wp-includes/link-template.php
index 2a1c7b2382..5a80a1cfde 100644
--- a/src/wp-includes/link-template.php
+++ b/src/wp-includes/link-template.php
@@ -2426,10 +2426,19 @@ function _navigation_markup( $links, $class = 'posts-navigation', $screen_reader
 	/**
 	 * 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.
 	 */
 	$template = apply_filters( 'navigation_markup_template', $template, $class );