From c8a224c48e263dd22e2144d6ac4da9515d12c151 Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Fri, 22 May 2015 17:59:25 +0000 Subject: [PATCH] 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 --- wp-includes/class-wp-walker.php | 47 +++++++++++++++++++-------------- wp-includes/version.php | 2 +- 2 files changed, 28 insertions(+), 21 deletions(-) diff --git a/wp-includes/class-wp-walker.php b/wp-includes/class-wp-walker.php index 24154c01bc..65d8a5869a 100644 --- a/wp-includes/class-wp-walker.php +++ b/wp-includes/class-wp-walker.php @@ -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; diff --git a/wp-includes/version.php b/wp-includes/version.php index 10030829f6..b87a100d6b 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @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.