Changeset 37057

Timestamp:

03/22/2016 06:06:58 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Mark optional method parameters as such in Walker_Page.

Also normalizes parameter spacing following [37056].

Fixes #36300.

File:

• trunk/src/wp-includes/class-walker-page.php (modified) (3 diffs)

trunk/src/wp-includes/class-walker-page.php

@@ -83 +83 @@
          * @access public
          *
-         * @param string $output       Passed by reference. Used to append additional content.
+         * @param string  $output       Used to append additional content. Passed by reference.
          * @param WP_Post $page         Page data object.
-         * @param int    $depth        Depth of page. Used for padding.
-         * @param array  $args         Optional arguments.
-         * @param int    $current_page Page ID.
+         * @param int     $depth        Optional. Depth of page. Used for padding. Default 0.
+         * @param array   $args         Optional. Array of arguments. Default empty array.
+         * @param int     $current_page Optional. Page ID. Default 0.
          */
         public function start_el( &$output, $page, $depth = 0, $args = array(), $current_page = 0 ) {
@@ -124 +124 @@
                  *
                  * @param array   $css_class    An array of CSS classes to be applied
-                 *                             to each list item.
+                 *                              to each list item.
                  * @param WP_Post $page         Page data object.
                  * @param int     $depth        Depth of page, used for padding.
@@ -170 +170 @@
          * @see Walker::end_el()
          *
-         * @param string $output Passed by reference. Used to append additional content.
-         * @param WP_Post $page Page data object. Not used.
-         * @param int    $depth Depth of page. Not Used.
-         * @param array  $args
+         * @param string  $output Used to append additional content. Passed by reference.
+         * @param WP_Post $page   Page data object. Not used.
+         * @param int     $depth  Optional. Depth of page. Default 0 (unused).
+         * @param array   $args   Optional. Array of arguments. Default empty array.
          */
         public function end_el( &$output, $page, $depth = 0, $args = array() ) {