<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[48364] trunk/src/wp-includes/nav-menu-template.php: Docs: Improve DocBlocks in `wp-includes/nav-menu-template.php` per the documentation standards.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/48364">48364</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48364","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-07 09:26:16 +0000 (Tue, 07 Jul 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve DocBlocks in `wp-includes/nav-menu-template.php` per the documentation standards.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesnavmenutemplatephp">trunk/src/wp-includes/nav-menu-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesnavmenutemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/nav-menu-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/nav-menu-template.php 2020-07-07 09:19:00 UTC (rev 48363)
+++ trunk/src/wp-includes/nav-menu-template.php 2020-07-07 09:26:16 UTC (rev 48364)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,14 +20,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array of nav menu arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type int|string|WP_Term $menu Desired menu. Accepts a menu ID, slug, name, or object. Default empty.
- * @type string $menu_class CSS class to use for the ul element which forms the menu. Default 'menu'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type int|string|WP_Term $menu Desired menu. Accepts a menu ID, slug, name, or object.
+ * Default empty.
+ * @type string $menu_class CSS class to use for the ul element which forms the menu.
+ * Default 'menu'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $menu_id The ID that is applied to the ul element which forms the menu.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default is the menu slug, incremented.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $container Whether to wrap the ul, and what to wrap it with. Default 'div'.
- * @type string $container_class Class that is applied to the container. Default 'menu-{menu slug}-container'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $container Whether to wrap the ul, and what to wrap it with.
+ * Default 'div'.
+ * @type string $container_class Class that is applied to the container.
+ * Default 'menu-{menu slug}-container'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $container_id The ID that is applied to the container. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $container_aria_label The aria-label attribute that is applied to the container when it's a nav element. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $container_aria_label The aria-label attribute that is applied to the container
+ * when it's a nav element. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type callable|bool $fallback_cb If the menu doesn't exist, a callback function will fire.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default is 'wp_page_menu'. Set to false for no fallback.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $before Text before the link markup. Default empty.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,13 +40,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $link_before Text before the link text. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $link_after Text after the link text. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $echo Whether to echo the menu or return it. Default true.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type int $depth How many levels of the hierarchy are to be included. 0 means all. Default 0.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type int $depth How many levels of the hierarchy are to be included.
+ * 0 means all. Default 0.
+ * Default 0.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type object $walker Instance of a custom walker class. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $theme_location Theme location to be used. Must be registered with register_nav_menu()
- * in order to be selectable by the user.
- * @type string $items_wrap How the list items should be wrapped. Default is a ul with an id and class.
- * Uses printf() format with numbered placeholders.
- * @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $theme_location Theme location to be used. Must be registered with
+ * register_nav_menu() in order to be selectable by the user.
+ * @type string $items_wrap How the list items should be wrapped. Uses printf() format with
+ * numbered placeholders. Default is a ul with an id and class.
+ * @type string $item_spacing Whether to preserve whitespace within the menu's HTML.
+ * Accepts 'preserve' or 'discard'. Default 'preserve'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void|string|false Void if 'echo' argument is true, menu output if 'echo' is false.
</span><span class="cx" style="display: block; padding: 0 10px"> * False if there are no items or no menu was found.
</span></span></pre>
</div>
</div>
</body>
</html>