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

See #32444.

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


git-svn-id: http://core.svn.wordpress.org/trunk@32519 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2015-05-22 17:59:25 +00:00
parent e90a327694
commit c8a224c48e
2 changed files with 28 additions and 21 deletions

View File

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

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.3-alpha-32548'; $wp_version = '4.3-alpha-32549';
/** /**
* 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.