Changeset 25641

Timestamp:

09/28/2013 06:01:26 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation improvements for Walker_Category and Walker_CategoryDropdown.

Also covers previously undocumented parameters.

See #23406, #19249.

File:

• trunk/src/wp-includes/category-template.php (modified) (7 diffs)

trunk/src/wp-includes/category-template.php

@@ -764 +764 @@
 class Walker_Category extends Walker {
     /**
+     * What the class handles.
+     *
      * @see Walker::$tree_type
      * @since 2.1.0
@@ -771 +773 @@
 
     /**
+     * Database fields to use.
+     *
      * @see Walker::$db_fields
      * @since 2.1.0
@@ -779 +783 @@
 
     /**
+     * Starts the list before the elements are added.
+     *
      * @see Walker::start_lvl()
+     *
      * @since 2.1.0
      *
      * @param string $output Passed by reference. Used to append additional content.
-     * @param int $depth Depth of category. Used for tab indentation.
-     * @param array $args Will only append content if style argument value is 'list'.
+     * @param int    $depth  Depth of category. Used for tab indentation.
+     * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
+     *                       @see wp_list_categories()
      */
     function start_lvl( &$output, $depth = 0, $args = array() ) {
@@ -795 +803 @@
 
     /**
+     * Ends the list of after the elements are added.
+     *
      * @see Walker::end_lvl()
+     *
      * @since 2.1.0
      *
      * @param string $output Passed by reference. Used to append additional content.
-     * @param int $depth Depth of category. Used for tab indentation.
-     * @param array $args Will only append content if style argument value is 'list'.
+     * @param int    $depth  Depth of category. Used for tab indentation.
+     * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
+     *                       @wsee wp_list_categories()
      */
     function end_lvl( &$output, $depth = 0, $args = array() ) {
@@ -811 +823 @@
 
     /**
+     * Start the element output.
+     *
      * @see Walker::start_el()
+     *
      * @since 2.1.0
      *
-     * @param string $output Passed by reference. Used to append additional content.
+     * @param string $output   Passed by reference. Used to append additional content.
      * @param object $category Category data object.
-     * @param int $depth Depth of category in reference to parents.
-     * @param array $args
+     * @param int    $depth    Depth of category in reference to parents. Default 0.
+     * @param array  $args     An array of arguments. @see wp_list_categories()
+     * @param int    $id       ID of the current category.
      */
     function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
@@ -883 +899 @@
 
     /**
+     * Ends the element output, if needed.
+     *
      * @see Walker::end_el()
+     *
      * @since 2.1.0
      *
      * @param string $output Passed by reference. Used to append additional content.
-     * @param object $page Not used.
-     * @param int $depth Depth of category. Not used.
-     * @param array $args Only uses 'list' for whether should append to output.
+     * @param object $page   Not used.
+     * @param int    $depth  Depth of category. Not used.
+     * @param array  $args   An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories()
      */
     function end_el( &$output, $page, $depth = 0, $args = array() ) {
@@ -924 +943 @@
 
     /**
+     * Start the element output.
+     *
      * @see Walker::start_el()
      * @since 2.1.0
      *
-     * @param string $output Passed by reference. Used to append additional content.
+     * @param string $output   Passed by reference. Used to append additional content.
      * @param object $category Category data object.
-     * @param int $depth Depth of category. Used for padding.
-     * @param array $args Uses 'selected' and 'show_count' keys, if they exist.
+     * @param int    $depth    Depth of category. Used for padding.
+     * @param array  $args     Uses 'selected' and 'show_count' keys, if they exist. @see wp_dropdown_categories()
      */
     function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {