Changeset 25643 for trunk/src/wp-admin/includes/nav-menu.php

Timestamp:

09/28/2013 09:01:54 PM (11 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for Walker_Nav_Menu, Walker_Nav_Menu_Edit, Walker_Nav_Menu_Checklist.

Includes previously undocumented parameters.

See #23406.

File:

• trunk/src/wp-admin/includes/nav-menu.php (modified) (6 diffs)

trunk/src/wp-admin/includes/nav-menu.php

@@ -10 +10 @@
 class Walker_Nav_Menu_Edit extends Walker_Nav_Menu {
     /**
+     * Starts the list before the elements are added.
+     *
      * @see Walker_Nav_Menu::start_lvl()
+     *
      * @since 3.0.0
      *
      * @param string $output Passed by reference.
+     * @param int    $depth  Depth of menu item. Used for padding.
+     * @param array  $args   Not used.
      */
     function start_lvl( &$output, $depth = 0, $args = array() ) {}
 
     /**
+     * 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.
+     * @param int    $depth  Depth of menu item. Used for padding.
+     * @param array  $args   Not used.
      */
     function end_lvl( &$output, $depth = 0, $args = array() ) {}
 
     /**
-     * @see Walker::start_el()
+     * Start the element output.
+     *
+     * @see Walker_Nav_Menu::start_el()
      * @since 3.0.0
      *
      * @param string $output Passed by reference. Used to append additional content.
-     * @param object $item Menu item data object.
-     * @param int $depth Depth of menu item. Used for padding.
-     * @param object $args
+     * @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.
      */
     function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
@@ -213 +226 @@
         $output .= ob_get_clean();
     }
-}
+
+} // Walker_Nav_Menu_Edit
 
 /**
@@ -229 +243 @@
     }
 
+    /**
+     * 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.
+     */
     function start_lvl( &$output, $depth = 0, $args = array() ) {
         $indent = str_repeat( "\t", $depth );
@@ -234 +259 @@
     }
 
+    /**
+     * 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.
+     */
     function end_lvl( &$output, $depth = 0, $args = array() ) {
         $indent = str_repeat( "\t", $depth );
@@ -240 +276 @@
 
     /**
-     * @see Walker::start_el()
+     * Start the element output.
+     *
+     * @see Walker_Nav_Menu::start_el()
+     *
      * @since 3.0.0
      *
      * @param string $output Passed by reference. Used to append additional content.
-     * @param object $item Menu item data object.
-     * @param int $depth Depth of menu item. Used for padding.
-     * @param object $args
+     * @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.
      */
     function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
@@ -285 +325 @@
         $output .= '<input type="hidden" class="menu-item-xfn" name="menu-item[' . $possible_object_id . '][menu-item-xfn]" value="'. esc_attr( $item->xfn ) .'" />';
     }
-}
+
+} // Walker_Nav_Menu_Checklist
 
 /**