enmi-conf.org: comparison wp/wp-includes/class-wp-walker.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 class Walker {
 	/**
 	 * What the class handles.
 	 *
 	 * @since 2.1.0
-	 * @access public
 	 * @var string
 	 */
 	public $tree_type;
 	/**
 	 * class methods. This method is called at the start of the output list.
 	 *
 	 * @since 2.1.0
 	 * @abstract
 	 *
-	 * @param string $output Passed by reference. Used to append additional content.
+	 * @param string $output Used to append additional content (passed by reference).
 	 * @param int    $depth  Depth of the item.
 	 * @param array  $args   An array of additional arguments.
 	 */
 	public function start_lvl( &$output, $depth = 0, $args = array() ) {}
 	 * class methods. This method finishes the list at the end of output of the elements.
 	 *
 	 * @since 2.1.0
 	 * @abstract
 	 *
-	 * @param string $output Passed by reference. Used to append additional content.
+	 * @param string $output Used to append additional content (passed by reference).
 	 * @param int    $depth  Depth of the item.
 	 * @param array  $args   An array of additional arguments.
 	 */
 	public function end_lvl( &$output, $depth = 0, $args = array() ) {}
 	 * class methods. Includes the element output also.
 	 *
 	 * @since 2.1.0
 	 * @abstract
 	 *
-	 * @param string $output            Passed by reference. Used to append additional content.
+	 * @param string $output            Used to append additional content (passed by reference).
 	 * @param object $object            The data object.
 	 * @param int    $depth             Depth of the item.
 	 * @param array  $args              An array of additional arguments.
 	 * @param int    $current_object_id ID of the current item.
 	 */
 	 * The $args parameter holds additional values that may be used with the child class methods.
 	 *
 	 * @since 2.1.0
 	 * @abstract
 	 *
-	 * @param string $output Passed by reference. Used to append additional content.
+	 * @param string $output Used to append additional content (passed by reference).
 	 * @param object $object The data object.
 	 * @param int    $depth  Depth of the item.
 	 * @param array  $args   An array of additional arguments.
 	 */
 	public function end_el( &$output, $object, $depth = 0, $args = array() ) {}
 	 * This method should not be called directly, use the walk() method instead.
 	 *
 	 * @since 2.5.0
 	 *
 	 * @param object $element           Data object.
-	 * @param array  $children_elements List of elements to continue traversing.
+	 * @param array  $children_elements List of elements to continue traversing (passed by reference).
 	 * @param int    $max_depth         Max depth to traverse.
 	 * @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.
+	 * @param string $output            Used to append additional content (passed by reference).
-	 * @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;
 		//display this element
 		$this->has_children = ! empty( $children_elements[ $id ] );
 		if ( isset( $args[0] ) && is_array( $args[0] ) ) {
-			$args[0]['has_children'] = $this->has_children; // Backwards compatibility.
+			$args[0]['has_children'] = $this->has_children; // Back-compat.
 		}
 		$cb_args = array_merge( array(&$output, $element, $depth), $args);
 		call_user_func_array(array($this, 'start_el'), $cb_args);
 		// descend only when the depth is right and there are childrens for this element
 		if ( ($max_depth == 0 || $max_depth > $depth+1 ) && isset( $children_elements[$id]) ) {
-			foreach( $children_elements[ $id ] as $child ){
+			foreach ( $children_elements[ $id ] as $child ){
 				if ( !isset($newlevel) ) {
 					$newlevel = true;
 					//start the child delimiter
 					$cb_args = array_merge( array(&$output, $depth), $args);
 	 *
 	 * @param array $elements  An array of elements.
 	 * @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
+		//invalid parameter or nothing to walk
+		if ( $max_depth < -1 || empty( $elements ) ) {
 			return $output;
+		}
-		if (empty($elements)) //nothing to walk
-			return $output;
 		$parent_field = $this->db_fields['parent'];
 		// flat display
 		if ( -1 == $max_depth ) {
 		 * Children_elements[10][] contains all sub-elements whose parent is 10.
 		 */
 		$top_level_elements = array();
 		$children_elements  = array();
 		foreach ( $elements as $e) {
-			if ( 0 == $e->$parent_field )
+			if ( empty( $e->$parent_field ) )
 				$top_level_elements[] = $e;
 			else
 				$children_elements[ $e->$parent_field ][] = $e;
 		}
 		 * then we got orphans, which should be displayed regardless.
 		 */
 		if ( ( $max_depth == 0 ) && count( $children_elements ) > 0 ) {
 			$empty_array = array();
 			foreach ( $children_elements as $orphans )
-				foreach( $orphans as $op )
+				foreach ( $orphans as $op )
 					$this->display_element( $op, $empty_array, 1, 0, $args, $output );
 		 }
 		 return $output;
 	}
 	 * $max_depth = 0 means display all levels.
 	 * $max_depth > 0 specifies the number of display levels.
 	 *
 	 * @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 ) {
+		if ( empty( $elements ) || $max_depth < -1 ) {
-		/* sanity check */
-		if ( empty($elements) || $max_depth < -1 )
 			return '';
+		}
 		$args = array_slice( func_get_args(), 4 );
 		$output = '';
 		$parent_field = $this->db_fields['parent'];
 		}
 		if ( $end >= $total_top && count( $children_elements ) > 0 ) {
 			$empty_array = array();
 			foreach ( $children_elements as $orphans )
-				foreach( $orphans as $op )
+				foreach ( $orphans as $op )
 					$this->display_element( $op, $empty_array, 1, 0, $args, $output );
 		}
 		return $output;
 	}
+	/**
+	 * Calculates the total number of root elements.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @param array $elements Elements to list.
+	 * @return int Number of root elements.
+	 */
 	public function get_number_of_root_elements( $elements ){
 		$num = 0;
 		$parent_field = $this->db_fields['parent'];
 		foreach ( $elements as $e) {
 			if ( 0 == $e->$parent_field )
 				$num++;
 		}
 		return $num;
 	}
-	// Unset all the children for a given top level element.
+	/**
+	 * Unset all the children for a given top level element.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @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;
 		if ( !empty($children_elements[$id]) && is_array($children_elements[$id]) )
 			foreach ( (array) $children_elements[$id] as $child )
 				$this->unset_children( $child, $children_elements );
-		if ( isset($children_elements[$id]) )
+		unset( $children_elements[ $id ] );
-			unset( $children_elements[$id] );
 	}
 } // Walker

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9