WPDev.one
Core Class

Walker

class Walker // Constructor: function Object() { [native code] }

A class for displaying various tree-like structures.

Methods 9 methods

Method / Return Description
start_lvl()
void

Starts the list before the elements are added.

Parameters: $output: mixed, $depth: mixed, $args: mixed
end_lvl()
void

Ends the list of after the elements are added.

Parameters: $output: mixed, $depth: mixed, $args: mixed
start_el()
void

Starts the element output.

Parameters: $output: mixed, $data_object: mixed, $depth: mixed, $args: mixed, $current_object_id: mixed
end_el()
void

Ends the element output, if needed.

Parameters: $output: mixed, $data_object: mixed, $depth: mixed, $args: mixed
display_element()
void

Traverses elements to create list from elements.

Parameters: $element: mixed, $children_elements: mixed, $max_depth: mixed, $depth: mixed, $args: mixed, $output: mixed
walk()
string

Displays array of elements hierarchically.

Parameters: $elements: mixed, $max_depth: mixed, $args: mixed
paged_walk()
string

Produces a page of nested elements.

Parameters: $elements: mixed, $max_depth: mixed, $page_num: mixed, $per_page: mixed, $args: mixed
get_number_of_root_elements()
int

Calculates the total number of root elements.

Parameters: $elements: mixed
unset_children()
void

Unsets all the children for a given top level element.

Parameters: $element: mixed, $children_elements: mixed

Properties

Property / Type Description
$tree_type
mixed
public
No description available.
$db_fields
mixed
public
No description available.
$max_pages
mixed
public
No description available.
$has_children
mixed
public
No description available.

Class Information

Since Version
2.1.0
Source File
wp-includes/class-wp-walker.php
Advertisement