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

Docs: Improve inline documentation for properties and methods in Walker_PageDropdown.

Browse Source 
Props raimy for the initial patch.
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37053 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-22 17:50:35 +00:00
parent 39bdd5fc3d
commit eacd0d863d
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -15,29 +15,35 @@
* @see Walker * @see Walker
*/ */
class Walker_PageDropdown extends Walker { class Walker_PageDropdown extends Walker {
/** /**
* Walker tree type. * What the class handles.
* *
* @since 2.1.0 * @since 2.1.0
* @see Walker::$tree_type * @access public
* @var string * @var string
*
* @see Walker::$tree_type
*/ */
public $tree_type = 'page'; public $tree_type = 'page';
/** /**
* Database fields. * Database fields to use.
* *
* @since 2.1.0 * @since 2.1.0
* @access public
* @var array
*
* @see Walker::$db_fields * @see Walker::$db_fields
* @todo Decouple this * @todo Decouple this
* @var array
*/ */
public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID'); public $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );
/** /**
* Starts the element output. * Starts the element output.
* *
* @since 2.1.0 * @since 2.1.0
* @access public
* *
* @see Walker::start_el() * @see Walker::start_el()
* *
@ -47,7 +53,7 @@ class Walker_PageDropdown extends Walker {
* Default 0. * Default 0.
* @param array $args Optional. Uses 'selected' argument for selected page to set selected HTML * @param array $args Optional. Uses 'selected' argument for selected page to set selected HTML
* attribute for option element. Uses 'value_field' argument to fill "value" * attribute for option element. Uses 'value_field' argument to fill "value"
* attribute. See {@see wp_dropdown_pages()}. Default empty array. * attribute. See wp_dropdown_pages(). Default empty array.
* @param int $id Optional. ID of the current page. Default 0 (unused). * @param int $id Optional. ID of the current page. Default 0 (unused).
*/ */
public function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) { public function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) {