sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Add more complete property and method documentation for Walker_Page.

Browse Source 
* Adds missing DocBlock summaries
* Adds missing `@param` descriptions
* Marks some optional parameters as such
* Reorders some DocBlock tags

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@35929 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-12-14 18:05:06 +00:00
parent 3ea73eb0d9
commit b3f7fd1741
1 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/wp-includes/class-walker-page.php
View File

@ -16,27 +16,35 @@
*/ */
class Walker_Page extends Walker { class Walker_Page extends Walker {
/** /**
* @see Walker::$tree_type * Walker tree type.
*
* @since 2.1.0 * @since 2.1.0
* @see Walker::$tree_type
* @var string * @var string
*/ */
public $tree_type = 'page'; public $tree_type = 'page';
/** /**
* @see Walker::$db_fields * Database fields.
*
* @since 2.1.0 * @since 2.1.0
* @see Walker::$db_fields
* @todo Decouple this. * @todo Decouple this.
* @var array * @var array
*/ */
public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID'); public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
/** /**
* @see Walker::start_lvl() * Outputs the beginning of the current level in the tree before elements are output.
*
* @since 2.1.0 * @since 2.1.0
* *
* @see Walker::start_lvl()
*
* @param string $output Passed by reference. Used to append additional content. * @param string $output Passed by reference. Used to append additional content.
* @param int $depth Depth of page. Used for padding. * @param int $depth Optional. Depth of page. Used for padding. Default 0.
* @param array $args * @param array $args Optional. Arguments for outputing the next level.
* Default empty array.
*/ */
public function start_lvl( &$output, $depth = 0, $args = array() ) { public function start_lvl( &$output, $depth = 0, $args = array() ) {
$indent = str_repeat("\t", $depth); $indent = str_repeat("\t", $depth);
@ -44,12 +52,16 @@ class Walker_Page extends Walker {
} }
/** /**
* @see Walker::end_lvl() * Outputs the end of the current level in the tree after elements are output.
*
* @since 2.1.0 * @since 2.1.0
* *
* @see Walker::end_lvl()
*
* @param string $output Passed by reference. Used to append additional content. * @param string $output Passed by reference. Used to append additional content.
* @param int $depth Depth of page. Used for padding. * @param int $depth Optional. Depth of page. Used for padding. Default 0.
* @param array $args * @param array $args Optional. Arguments for outputting the end of the current level.
* Default empty array.
*/ */
public function end_lvl( &$output, $depth = 0, $args = array() ) { public function end_lvl( &$output, $depth = 0, $args = array() ) {
$indent = str_repeat("\t", $depth); $indent = str_repeat("\t", $depth);
@ -57,6 +69,8 @@ class Walker_Page extends Walker {
} }
/** /**
* Outputs the beginning of the current element in the tree.
*
* @see Walker::start_el() * @see Walker::start_el()
* @since 2.1.0 * @since 2.1.0
* *
@ -140,9 +154,12 @@ class Walker_Page extends Walker {
} }
/** /**
* @see Walker::end_el() * Outputs the end of the current element in the tree.
*
* @since 2.1.0 * @since 2.1.0
* *
* @see Walker::end_el()
*
* @param string $output Passed by reference. Used to append additional content. * @param string $output Passed by reference. Used to append additional content.
* @param object $page Page data object. Not used. * @param object $page Page data object. Not used.
* @param int $depth Depth of page. Not Used. * @param int $depth Depth of page. Not Used.