[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-walker-page.php (summary)

Post API: Walker_Page class

File Size: 245 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Walker_Page:: (4 methods):
  start_lvl()
  end_lvl()
  start_el()
  end_el()


Class: Walker_Page  - X-Ref

Core walker class used to create an HTML list of pages.

start_lvl( &$output, $depth = 0, $args = array()   X-Ref
Outputs the beginning of the current level in the tree before elements are output.

since: 2.1.0
param: string $output Used to append additional content (passed by reference).
param: int    $depth  Optional. Depth of page. Used for padding. Default 0.
param: array  $args   Optional. Arguments for outputting the next level.

end_lvl( &$output, $depth = 0, $args = array()   X-Ref
Outputs the end of the current level in the tree after elements are output.

since: 2.1.0
param: string $output Used to append additional content (passed by reference).
param: int    $depth  Optional. Depth of page. Used for padding. Default 0.
param: array  $args   Optional. Arguments for outputting the end of the current level.

start_el( &$output, $data_object, $depth = 0, $args = array()   X-Ref
Outputs the beginning of the current element in the tree.

since: 2.1.0
since: 5.9.0 Renamed `$page` to `$data_object` and `$current_page` to `$current_object_id`
param: string  $output            Used to append additional content. Passed by reference.
param: WP_Post $data_object       Page data object.
param: int     $depth             Optional. Depth of page. Used for padding. Default 0.
param: array   $args              Optional. Array of arguments. Default empty array.
param: int     $current_object_id Optional. ID of the current page. Default 0.

end_el( &$output, $data_object, $depth = 0, $args = array()   X-Ref
Outputs the end of the current element in the tree.

since: 2.1.0
since: 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
param: string  $output      Used to append additional content. Passed by reference.
param: WP_Post $data_object Page data object. Not used.
param: int     $depth       Optional. Depth of page. Default 0 (unused).
param: array   $args        Optional. Array of arguments. Default empty array.



Generated: Wed Oct 20 01:00:08 2021 Cross-referenced by PHPXref 0.7.1