sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Cleanup missing doc blocks for `class-wp-walker.php`. 

See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32549 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor 2015-05-22 17:58:42 +00:00
parent 366d1843f0
commit 4eb0e01825
1 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -127,12 +127,11 @@ class Walker {
* @param int $depth Depth of current element.
* @param array $args An array of arguments.
* @param string $output Passed by reference. Used to append additional content.
* @return null Null on failure with no changes to parameters.
*/
public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
if ( !$element )
if ( ! $element ) {
return;
}
$id_field = $this->db_fields['id'];
$id = $element->$id_field;
@ -188,16 +187,14 @@ class Walker {
* @param int $max_depth The maximum hierarchical depth.
* @return string The hierarchical item output.
*/
public function walk( $elements, $max_depth) {
public function walk( $elements, $max_depth ) {
$args = array_slice(func_get_args(), 2);
$output = '';
if ($max_depth < -1) //invalid parameter
return $output;
if (empty($elements)) //nothing to walk
//invalid parameter or nothing to walk
if ( $max_depth < -1 || empty( $elements ) ) {
return $output;
}
$parent_field = $this->db_fields['parent'];
@ -272,15 +269,16 @@ class Walker {
*
* @since 2.7.0
*
* @param int $max_depth The maximum hierarchical depth.
* @param int $page_num The specific page number, beginning with 1.
* @return string XHTML of the specified page of elements
*/
* @param array $elements
* @param int $max_depth The maximum hierarchical depth.
* @param int $page_num The specific page number, beginning with 1.
* @param int $per_page
* @return string XHTML of the specified page of elements
*/
public function paged_walk( $elements, $max_depth, $page_num, $per_page ) {
/* sanity check */
if ( empty($elements) || $max_depth < -1 )
if ( empty( $elements ) || $max_depth < -1 ) {
return '';
}
$args = array_slice( func_get_args(), 4 );
$output = '';
@ -383,8 +381,12 @@ class Walker {
return $output;
}
/**
*
* @param array $elements
* @return int
*/
public function get_number_of_root_elements( $elements ){
$num = 0;
$parent_field = $this->db_fields['parent'];
@ -395,11 +397,16 @@ class Walker {
return $num;
}
// Unset all the children for a given top level element.
/**
* Unset all the children for a given top level element.
*
* @param object $e
* @param array $children_elements
*/
public function unset_children( $e, &$children_elements ){
if ( !$e || !$children_elements )
if ( ! $e || ! $children_elements ) {
return;
}
$id_field = $this->db_fields['id'];
$id = $e->$id_field;