Docs: Improve inline documentation for properties and methods in `Walker_Page`.
Props raimy. See #36300. git-svn-id: https://develop.svn.wordpress.org/trunk@37055 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
6f43565b51
commit
c7d05cff99
|
@ -15,29 +15,35 @@
|
|||
* @see Walker
|
||||
*/
|
||||
class Walker_Page extends Walker {
|
||||
|
||||
/**
|
||||
* Walker tree type.
|
||||
* What the class handles.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @see Walker::$tree_type
|
||||
* @access public
|
||||
* @var string
|
||||
*
|
||||
* @see Walker::$tree_type
|
||||
*/
|
||||
public $tree_type = 'page';
|
||||
|
||||
/**
|
||||
* Database fields.
|
||||
* Database fields to use.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access private
|
||||
* @var array
|
||||
*
|
||||
* @see Walker::$db_fields
|
||||
* @todo Decouple this.
|
||||
* @var array
|
||||
*/
|
||||
public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
|
||||
public $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );
|
||||
|
||||
/**
|
||||
* Outputs the beginning of the current level in the tree before elements are output.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access public
|
||||
*
|
||||
* @see Walker::start_lvl()
|
||||
*
|
||||
|
@ -55,6 +61,7 @@ class Walker_Page extends Walker {
|
|||
* Outputs the end of the current level in the tree after elements are output.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access public
|
||||
*
|
||||
* @see Walker::end_lvl()
|
||||
*
|
||||
|
@ -73,6 +80,7 @@ class Walker_Page extends Walker {
|
|||
*
|
||||
* @see Walker::start_el()
|
||||
* @since 2.1.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $output Passed by reference. Used to append additional content.
|
||||
* @param object $page Page data object.
|
||||
|
@ -157,6 +165,7 @@ class Walker_Page extends Walker {
|
|||
* Outputs the end of the current element in the tree.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @access public
|
||||
*
|
||||
* @see Walker::end_el()
|
||||
*
|
||||
|
|
Loading…
Reference in New Issue