<!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>[25643] trunk/src: Improve inline documentation for `Walker_Nav_Menu`, `Walker_Nav_Menu_Edit`, `Walker_Nav_Menu_Checklist`.</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 { 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25643">25643</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-09-28 21:01:54 +0000 (Sat, 28 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline documentation for `Walker_Nav_Menu`, `Walker_Nav_Menu_Edit`, `Walker_Nav_Menu_Checklist`.
Includes previously undocumented parameters.
See <a href="http://core.trac.wordpress.org/ticket/23406">#23406</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesnavmenuphp">trunk/src/wp-admin/includes/nav-menu.php</a></li>
<li><a href="#trunksrcwpincludesnavmenutemplatephp">trunk/src/wp-includes/nav-menu-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesnavmenuphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/nav-menu.php (25642 => 25643)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/nav-menu.php 2013-09-28 18:07:02 UTC (rev 25642)
+++ trunk/src/wp-admin/includes/nav-menu.php 2013-09-28 21:01:54 UTC (rev 25643)
</span><span class="lines">@@ -9,29 +9,42 @@
</span><span class="cx"> */
</span><span class="cx"> class Walker_Nav_Menu_Edit extends Walker_Nav_Menu {
</span><span class="cx"> /**
</span><ins>+ * Starts the list before the elements are added.
+ *
</ins><span class="cx"> * @see Walker_Nav_Menu::start_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference.
</span><ins>+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args Not used.
</ins><span class="cx"> */
</span><span class="cx"> function start_lvl( &$output, $depth = 0, $args = array() ) {}
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Ends the list of after the elements are added.
+ *
</ins><span class="cx"> * @see Walker_Nav_Menu::end_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference.
</span><ins>+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args Not used.
</ins><span class="cx"> */
</span><span class="cx"> function end_lvl( &$output, $depth = 0, $args = array() ) {}
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @see Walker::start_el()
</del><ins>+ * Start the element output.
+ *
+ * @see Walker_Nav_Menu::start_el()
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param object $item Menu item data object.
- * @param int $depth Depth of menu item. Used for padding.
- * @param object $args
</del><ins>+ * @param object $item Menu item data object.
+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args Not used.
+ * @param int $id Not used.
</ins><span class="cx"> */
</span><span class="cx"> function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx"> global $_wp_nav_menu_max_depth;
</span><span class="lines">@@ -212,8 +225,9 @@
</span><span class="cx"> <?php
</span><span class="cx"> $output .= ob_get_clean();
</span><span class="cx"> }
</span><del>-}
</del><span class="cx">
</span><ins>+} // Walker_Nav_Menu_Edit
+
</ins><span class="cx"> /**
</span><span class="cx"> * Create HTML list of nav menu input items.
</span><span class="cx"> *
</span><span class="lines">@@ -228,24 +242,50 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Starts the list before the elements are added.
+ *
+ * @see Walker_Nav_Menu::start_lvl()
+ *
+ * @since 3.0.0
+ *
+ * @param string $output Passed by reference. Used to append additional content.
+ * @param int $depth Depth of page. Used for padding.
+ * @param array $args Not used.
+ */
</ins><span class="cx"> function start_lvl( &$output, $depth = 0, $args = array() ) {
</span><span class="cx"> $indent = str_repeat( "\t", $depth );
</span><span class="cx"> $output .= "\n$indent<ul class='children'>\n";
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Ends the list of after the elements are added.
+ *
+ * @see Walker_Nav_Menu::end_lvl()
+ *
+ * @since 3.0.0
+ *
+ * @param string $output Passed by reference. Used to append additional content.
+ * @param int $depth Depth of page. Used for padding.
+ * @param array $args Not used.
+ */
</ins><span class="cx"> function end_lvl( &$output, $depth = 0, $args = array() ) {
</span><span class="cx"> $indent = str_repeat( "\t", $depth );
</span><span class="cx"> $output .= "\n$indent</ul>";
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @see Walker::start_el()
</del><ins>+ * Start the element output.
+ *
+ * @see Walker_Nav_Menu::start_el()
+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param object $item Menu item data object.
- * @param int $depth Depth of menu item. Used for padding.
- * @param object $args
</del><ins>+ * @param object $item Menu item data object.
+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args Not used.
+ * @param int $id Not used.
</ins><span class="cx"> */
</span><span class="cx"> function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx"> global $_nav_menu_placeholder;
</span><span class="lines">@@ -284,8 +324,9 @@
</span><span class="cx"> $output .= '<input type="hidden" class="menu-item-classes" name="menu-item[' . $possible_object_id . '][menu-item-classes]" value="'. esc_attr( implode( ' ', $item->classes ) ) .'" />';
</span><span class="cx"> $output .= '<input type="hidden" class="menu-item-xfn" name="menu-item[' . $possible_object_id . '][menu-item-xfn]" value="'. esc_attr( $item->xfn ) .'" />';
</span><span class="cx"> }
</span><del>-}
</del><span class="cx">
</span><ins>+} // Walker_Nav_Menu_Checklist
+
</ins><span class="cx"> /**
</span><span class="cx"> * Prints the appropriate response to a menu quick search.
</span><span class="cx"> *
</span></span></pre></div>
<a id="trunksrcwpincludesnavmenutemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/nav-menu-template.php (25642 => 25643)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/nav-menu-template.php 2013-09-28 18:07:02 UTC (rev 25642)
+++ trunk/src/wp-includes/nav-menu-template.php 2013-09-28 21:01:54 UTC (rev 25643)
</span><span class="lines">@@ -16,6 +16,8 @@
</span><span class="cx"> */
</span><span class="cx"> class Walker_Nav_Menu extends Walker {
</span><span class="cx"> /**
</span><ins>+ * What the class handles.
+ *
</ins><span class="cx"> * @see Walker::$tree_type
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> * @var string
</span><span class="lines">@@ -23,6 +25,8 @@
</span><span class="cx"> var $tree_type = array( 'post_type', 'taxonomy', 'custom' );
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Database fields to use.
+ *
</ins><span class="cx"> * @see Walker::$db_fields
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> * @todo Decouple this.
</span><span class="lines">@@ -31,11 +35,15 @@
</span><span class="cx"> var $db_fields = array( 'parent' => 'menu_item_parent', 'id' => 'db_id' );
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Starts the list before the elements are added.
+ *
</ins><span class="cx"> * @see Walker::start_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param int $depth Depth of page. Used for padding.
</del><ins>+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args An array of arguments. @see wp_nav_menu()
</ins><span class="cx"> */
</span><span class="cx"> function start_lvl( &$output, $depth = 0, $args = array() ) {
</span><span class="cx"> $indent = str_repeat("\t", $depth);
</span><span class="lines">@@ -43,11 +51,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Ends the list of after the elements are added.
+ *
</ins><span class="cx"> * @see Walker::end_lvl()
</span><ins>+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param int $depth Depth of page. Used for padding.
</del><ins>+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args An array of arguments. @see wp_nav_menu()
</ins><span class="cx"> */
</span><span class="cx"> function end_lvl( &$output, $depth = 0, $args = array() ) {
</span><span class="cx"> $indent = str_repeat("\t", $depth);
</span><span class="lines">@@ -55,14 +67,17 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Start the element output.
+ *
</ins><span class="cx"> * @see Walker::start_el()
</span><ins>+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param object $item Menu item data object.
- * @param int $depth Depth of menu item. Used for padding.
- * @param int $current_page Menu item ID.
- * @param object $args
</del><ins>+ * @param object $item Menu item data object.
+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args An array of arguments. @see wp_nav_menu()
+ * @param int $id Current item ID.
</ins><span class="cx"> */
</span><span class="cx"> function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx"> $indent = ( $depth ) ? str_repeat( "\t", $depth ) : '';
</span><span class="lines">@@ -77,9 +92,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param array $classes The CSS classes that are applied to the menu item's <li>.
- * @param object $item The current menu item.
- * @param array $args Arguments from {@see wp_nav_menu()}.
</del><ins>+ * @param array $classes The CSS classes that are applied to the menu item's <li>.
+ * @param object $item The current menu item.
+ * @param array $args An array of arguments. @see wp_nav_menu()
</ins><span class="cx"> */
</span><span class="cx"> $class_names = join( ' ', apply_filters( 'nav_menu_css_class', array_filter( $classes ), $item, $args ) );
</span><span class="cx"> $class_names = $class_names ? ' class="' . esc_attr( $class_names ) . '"' : '';
</span><span class="lines">@@ -91,7 +106,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string The ID that is applied to the menu item's <li>.
</span><span class="cx"> * @param object $item The current menu item.
</span><del>- * @param array $args Arguments from {@see wp_nav_menu()}.
</del><ins>+ * @param array $args An array of arguments. @see wp_nav_menu()
</ins><span class="cx"> */
</span><span class="cx"> $id = apply_filters( 'nav_menu_item_id', 'menu-item-'. $item->ID, $item, $args );
</span><span class="cx"> $id = $id ? ' id="' . esc_attr( $id ) . '"' : '';
</span><span class="lines">@@ -112,13 +127,13 @@
</span><span class="cx"> * @param array $atts {
</span><span class="cx"> * The HTML attributes applied to the menu item's <a>, empty strings are ignored.
</span><span class="cx"> *
</span><del>- * @type string $title The title attribute.
</del><ins>+ * @type string $title The title attribute.
</ins><span class="cx"> * @type string $target The target attribute.
</span><del>- * @type string $rel The rel attribute.
- * @type string $href The href attribute.
</del><ins>+ * @type string $rel The rel attribute.
+ * @type string $href The href attribute.
</ins><span class="cx"> * }
</span><span class="cx"> * @param object $item The current menu item.
</span><del>- * @param array $args Arguments from {@see wp_nav_menu()}.
</del><ins>+ * @param array $args An array of arguments. @see wp_nav_menu()
</ins><span class="cx"> */
</span><span class="cx"> $atts = apply_filters( 'nav_menu_link_attributes', $atts, $item, $args );
</span><span class="cx">
</span><span class="lines">@@ -146,27 +161,32 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param string The menu item's starting HTML output.
- * @param object $item The current menu item.
- * @param int $depth From {@see Walker_Nav_Menu::start_el}.
- * @param array $args Arguments from {@see wp_nav_menu()}.
</del><ins>+ * @param string $item_output The menu item's starting HTML output.
+ * @param object $item Menu item data object.
+ * @param int $depth Depth of menu item. Used for padding.
+ * @param array $args An array of arguments. @see wp_nav_menu()
</ins><span class="cx"> */
</span><span class="cx"> $output .= apply_filters( 'walker_nav_menu_start_el', $item_output, $item, $depth, $args );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Ends the element output, if needed.
+ *
</ins><span class="cx"> * @see Walker::end_el()
</span><ins>+ *
</ins><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $output Passed by reference. Used to append additional content.
</span><del>- * @param object $item Page data object. Not used.
- * @param int $depth Depth of page. Not Used.
</del><ins>+ * @param object $item Page data object. Not used.
+ * @param int $depth Depth of page. Not Used.
+ * @param array $args An array of arguments. @see wp_nav_menu()
</ins><span class="cx"> */
</span><span class="cx"> function end_el( &$output, $item, $depth = 0, $args = array() ) {
</span><span class="cx"> $output .= "</li>\n";
</span><span class="cx"> }
</span><del>-}
</del><span class="cx">
</span><ins>+} // Walker_Nav_Menu
+
</ins><span class="cx"> /**
</span><span class="cx"> * Displays a navigation menu.
</span><span class="cx"> *
</span></span></pre>
</div>
</div>
</body>
</html>