Changeset 53318

Timestamp:

04/29/2022 07:27:00 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation of the walker argument for various functions.

See #54729

Location:

trunk/src

Files:

• wp-admin/includes/template.php (modified) (1 diff)
• wp-includes/category-template.php (modified) (2 diffs)
• wp-includes/post-template.php (modified) (2 diffs)

trunk/src/wp-admin/includes/template.php

@@ -69 +69 @@
  *     @type int[]  $popular_cats         Array of category IDs to receive the "popular-category" class.
  *                                        Default false.
- *     @type Walker $walker               Walker object to use to build the output.
- *                                        Default is a Walker_Category_Checklist instance.
+ *     @type Walker $walker               Walker object to use to build the output. Default empty which
+ *                                        results in a Walker_Category_Checklist instance being used.
  *     @type string $taxonomy             Taxonomy to generate the checklist for. Default 'category'.
  *     @type bool   $checked_ontop        Whether to move checked items out of the hierarchy and to

trunk/src/wp-includes/category-template.php

@@ -332 +332 @@
  *     @type bool         $required          Whether the `<select>` element should have the HTML5 'required' attribute.
  *                                           Default false.
+ *     @type Walker       $walker            Walker object to use to build the output. Default empty which results in a
+ *                                           Walker_CategoryDropdown instance being used.
  * }
  * @return string HTML dropdown list of categories.
@@ -519 +521 @@
  *     @type bool|int     $use_desc_for_title    Whether to use the category description as the title attribute.
  *                                               Accepts 0, 1, or their bool equivalents. Default 1.
+ *     @type Walker       $walker                Walker object to use to build the output. Default empty which results
+ *                                               in a Walker_Category instance being used.
  * }
  * @return void|string|false Void if 'echo' argument is true, HTML list of categories if 'echo' is false.

trunk/src/wp-includes/post-template.php

@@ -1260 +1260 @@
  *     @type string       $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'.
  *                                      Default 'preserve'.
- *     @type Walker       $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
+ *     @type Walker       $walker       Walker instance to use for listing pages. Default empty which results in a
+ *                                      Walker_Page instance being used.
  * }
  * @return void|string Void if 'echo' argument is true, HTML list of pages if 'echo' is false.
@@ -1382 +1383 @@
  *     @type string          $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve'
  *                                         or 'discard'. Default 'discard'.
- *     @type Walker          $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
+ *     @type Walker          $walker       Walker instance to use for listing pages. Default empty which results in a
+ *                                         Walker_Page instance being used.
  * }
  * @return void|string Void if 'echo' argument is true, HTML menu if 'echo' is false.