Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-19 19:42:36 +02:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
See #54729

Built from https://develop.svn.wordpress.org/trunk@53318


git-svn-id: http://core.svn.wordpress.org/trunk@52907 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2022-04-29 19:28:09 +00:00
parent cd9aade1bd
commit bdaba2407c
4 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
wp-admin/includes/template.php
View File

@ -68,8 +68,8 @@ function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $select
* @type int[] $selected_cats Array of category IDs to mark as checked. Default false. * @type int[] $selected_cats Array of category IDs to mark as checked. Default false.
* @type int[] $popular_cats Array of category IDs to receive the "popular-category" class. * @type int[] $popular_cats Array of category IDs to receive the "popular-category" class.
* Default false. * Default false.
* @type Walker $walker Walker object to use to build the output. * @type Walker $walker Walker object to use to build the output. Default empty which
* Default is a Walker_Category_Checklist instance. * results in a Walker_Category_Checklist instance being used.
* @type string $taxonomy Taxonomy to generate the checklist for. Default 'category'. * @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 * @type bool $checked_ontop Whether to move checked items out of the hierarchy and to
* the top of the list. Default true. * the top of the list. Default true.

4
wp-includes/category-template.php
View File

@ -331,6 +331,8 @@ function category_description( $category = 0 ) {
* Default false (create select element even if no categories are found). * Default false (create select element even if no categories are found).
* @type bool $required Whether the `<select>` element should have the HTML5 'required' attribute. * @type bool $required Whether the `<select>` element should have the HTML5 'required' attribute.
* Default false. * 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. * @return string HTML dropdown list of categories.
*/ */
@ -518,6 +520,8 @@ function wp_dropdown_categories( $args = '' ) {
* to disable. Default 'Categories'. * to disable. Default 'Categories'.
* @type bool|int $use_desc_for_title Whether to use the category description as the title attribute. * @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. * 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. * @return void|string|false Void if 'echo' argument is true, HTML list of categories if 'echo' is false.
* False if the taxonomy does not exist. * False if the taxonomy does not exist.

6
wp-includes/post-template.php
View File

@ -1259,7 +1259,8 @@ function wp_dropdown_pages( $args = '' ) {
* will not be wrapped with unordered list `<ul>` tags. Default 'Pages'. * will not be wrapped with unordered list `<ul>` tags. Default 'Pages'.
* @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. * @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'.
* Default 'preserve'. * 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. * @return void|string Void if 'echo' argument is true, HTML list of pages if 'echo' is false.
*/ */
@ -1381,7 +1382,8 @@ function wp_list_pages( $args = '' ) {
* @type string $after The HTML or text to append to the menu. Default is '</ul>'. * @type string $after The HTML or text to append to the menu. Default is '</ul>'.
* @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' * @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve'
* or 'discard'. Default 'discard'. * 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. * @return void|string Void if 'echo' argument is true, HTML menu if 'echo' is false.
*/ */

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.0-beta3-53317'; $wp_version = '6.0-beta3-53318';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.