Changeset 35928

Timestamp:

12/14/2015 05:53:49 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add a missing description for the $id parameter in the DocBlock for Walker_PageDropdown::start_el(), which is implemented by Walker but unused by the subclass method.

Also marks the other optional parameters as such.

See #32246.

File:

• trunk/src/wp-includes/class-walker-page-dropdown.php (modified) (1 diff)

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

@@ -37 +37 @@
      * @param string $output Passed by reference. Used to append additional content.
      * @param object $page   Page data object.
-     * @param int    $depth  Depth of page in reference to parent pages. Used for padding.
-     * @param array  $args   Uses 'selected' argument for selected page to set selected HTML attribute for option
-     *                       element. Uses 'value_field' argument to fill "value" attribute. See {@see wp_dropdown_pages()}.
-     * @param int    $id
+     * @param int    $depth  Optional. Depth of page in reference to parent pages. Used for padding.
+     *                       Default 0.
+     * @param array  $args   Optional. Uses 'selected' argument for selected page to set selected HTML
+     *                       attribute for option element. Uses 'value_field' argument to fill "value"
+     *                       attribute. See {@see wp_dropdown_pages()}. Default empty array.
+     * @param int    $id     Optional. ID of the current page. Default 0 (unused).
      */
     public function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) {