]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/class-walker-page-dropdown.php
Wordpress 4.5.3
[autoinstalls/wordpress.git] / wp-includes / class-walker-page-dropdown.php
index e9196dd4f5b278d8536afd4e9a68473567c42e46..4c350cfc55c393a8ce6a2b7c65ae3c442467f4cf 100644 (file)
  * @see Walker
  */
 class Walker_PageDropdown extends Walker {
+
        /**
-        * @see Walker::$tree_type
+        * What the class handles.
+        *
         * @since 2.1.0
+        * @access public
         * @var string
+        *
+        * @see Walker::$tree_type
         */
        public $tree_type = 'page';
 
        /**
-        * @see Walker::$db_fields
+        * Database fields to use.
+        *
         * @since 2.1.0
-        * @todo Decouple this
+        * @access public
         * @var array
+        *
+        * @see Walker::$db_fields
+        * @todo Decouple this
         */
-       public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
+       public $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );
 
        /**
-        * @see Walker::start_el()
+        * Starts the element output.
+        *
         * @since 2.1.0
+        * @access public
+        *
+        * @see Walker::start_el()
         *
-        * @param string $output Passed by reference. Used to append additional content.
-        * @param object $page   Page data object.
-        * @param int    $depth  Depth of page in reference to parent pages. Used for padding.
-        * @param array  $args   Uses 'selected' argument for selected page to set selected HTML attribute for option
-        *                       element. Uses 'value_field' argument to fill "value" attribute. See {@see wp_dropdown_pages()}.
-        * @param int    $id
+        * @param string  $output Used to append additional content. Passed by reference.
+        * @param WP_Post $page   Page data object.
+        * @param int     $depth  Optional. Depth of page in reference to parent pages. Used for padding.
+        *                        Default 0.
+        * @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. See wp_dropdown_pages(). Default empty array.
+        * @param int     $id     Optional. ID of the current page. Default 0 (unused).
         */
        public function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) {
                $pad = str_repeat(' ', $depth * 3);
@@ -68,6 +83,7 @@ class Walker_PageDropdown extends Walker {
                 * @param object $page  Page data object.
                 */
                $title = apply_filters( 'list_pages', $title, $page );
+
                $output .= $pad . esc_html( $title );
                $output .= "</option>\n";
        }