vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Docblock adjustements in the Walker class.

Browse Source 
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.


git-svn-id: https://develop.svn.wordpress.org/trunk@53323 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jb Audras 2022-05-01 21:39:02 +00:00
parent fe01209090
commit 4cfee4c129
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -29,7 +29,7 @@ class Walker {
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
* @var int
@ -77,10 +77,10 @@ class Walker {
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
* class methods. Includes the element output also.
* class methods. Also includes the element output.
*
* @since 2.1.0
* @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() ) {}
/**
* 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 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.
*
@ -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,
* 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 $per_page Number of elements per page.
* @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 ) {
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
*