WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Docblock adjustements in the `Walker` class. 

This changeset ensures third-person singular verbs are used for function descriptions in the `Walker` class, and adjusts some non-standard docblock descriptions for various properties and methods of the class.

See #54729.

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


git-svn-id: http://core.svn.wordpress.org/trunk@52912 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2022-05-01 21:41:12 +00:00
parent c36f700fda
commit 9df9561ce9
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
wp-includes/class-wp-walker.php
View File

@ -29,7 +29,7 @@ class Walker {
public $db_fields; public $db_fields;
/** /**
* Max number of pages walked by the paged walker * Max number of pages walked by the paged walker.
* *
* @since 2.7.0 * @since 2.7.0
* @var int * @var int
@ -77,10 +77,10 @@ class Walker {
public function end_lvl( &$output, $depth = 0, $args = array() ) {} public function end_lvl( &$output, $depth = 0, $args = array() ) {}
/** /**
* Start the element output. * Starts the element output.
* *
* The $args parameter holds additional values that may be used with the child * The $args parameter holds additional values that may be used with the child
* class methods. Includes the element output also. * class methods. Also includes the element output.
* *
* @since 2.1.0 * @since 2.1.0
* @since 5.9.0 Renamed `$object` (a PHP reserved keyword) to `$data_object` for PHP 8 named parameter support. * @since 5.9.0 Renamed `$object` (a PHP reserved keyword) to `$data_object` for PHP 8 named parameter support.
@ -111,7 +111,7 @@ class Walker {
public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {} public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {}
/** /**
* Traverse elements to create list from elements. * Traverses elements to create list from elements.
* *
* Display one element if the element doesn't have any children otherwise, * Display one element if the element doesn't have any children otherwise,
* display the element and its children. Will only traverse up to the max * display the element and its children. Will only traverse up to the max
@ -170,7 +170,7 @@ class Walker {
} }
/** /**
* Display array of elements hierarchically. * Displays array of elements hierarchically.
* *
* Does not assume any existing order of elements. * Does not assume any existing order of elements.
* *
@ -263,7 +263,7 @@ class Walker {
} }
/** /**
* paged_walk() - produce a page of nested elements * Produces a page of nested elements.
* *
* Given an array of hierarchical elements, the maximum depth, a specific page number, * Given an array of hierarchical elements, the maximum depth, a specific page number,
* and number of elements per page, this function first determines all top level root elements * and number of elements per page, this function first determines all top level root elements
@ -281,7 +281,7 @@ class Walker {
* @param int $page_num The specific page number, beginning with 1. * @param int $page_num The specific page number, beginning with 1.
* @param int $per_page Number of elements per page. * @param int $per_page Number of elements per page.
* @param mixed ...$args Optional additional arguments. * @param mixed ...$args Optional additional arguments.
* @return string XHTML of the specified page of elements * @return string XHTML of the specified page of elements.
*/ */
public function paged_walk( $elements, $max_depth, $page_num, $per_page, ...$args ) { public function paged_walk( $elements, $max_depth, $page_num, $per_page, ...$args ) {
if ( empty( $elements ) || $max_depth < -1 ) { if ( empty( $elements ) || $max_depth < -1 ) {
@ -422,7 +422,7 @@ class Walker {
} }
/** /**
* Unset all the children for a given top level element. * Unsets all the children for a given top level element.
* *
* @since 2.7.0 * @since 2.7.0
* *

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.0-beta3-53322'; $wp_version = '6.0-beta3-53323';
/** /**
* 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.