Changeset 25642

Timestamp:

09/28/2013 06:07:02 PM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for Walker_Category_Checklist.

See #23406.

File:

• trunk/src/wp-admin/includes/template.php (modified) (4 diffs)

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

@@ -25 +25 @@
         var $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); //TODO: decouple this
 
+        /**
+         * Starts the list before the elements are added.
+         *
+         * @see Walker:start_lvl()
+         *
+         * @since 2.5.1
+         *
+         * @param string $output Passed by reference. Used to append additional content.
+         * @param int    $depth  Depth of category. Used for tab indentation.
+         * @param array  $args   An array of arguments. @see wp_terms_checklist()
+         */
         function start_lvl( &$output, $depth = 0, $args = array() ) {
                 $indent = str_repeat("\t", $depth);
@@ -30 +41 @@
         }
 
+        /**
+         * Ends the list of after the elements are added.
+         *
+         * @see Walker::end_lvl()
+         *
+         * @since 2.5.1
+         *
+         * @param string $output Passed by reference. Used to append additional content.
+         * @param int    $depth  Depth of category. Used for tab indentation.
+         * @param array  $args   An array of arguments. @see wp_terms_checklist()
+         */
         function end_lvl( &$output, $depth = 0, $args = array() ) {
                 $indent = str_repeat("\t", $depth);
@@ -35 +57 @@
         }
 
+        /**
+         * Start the element output.
+         *
+         * @see Walker::start_el()
+         *
+         * @since 2.5.1
+         *
+         * @param string $output   Passed by reference. Used to append additional content.
+         * @param object $category The current term object.
+         * @param int    $depth    Depth of the term in reference to parents. Default 0.
+         * @param array  $args     An array of arguments. @see wp_terms_checklist()
+         * @param int    $id       ID of the current term.
+         */
         function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
                 extract($args);
@@ -49 +84 @@
         }
 
+        /**
+         * Ends the element output, if needed.
+         *
+         * @see Walker::end_el()
+         *
+         * @since 2.5.1
+         *
+         * @param string $output   Passed by reference. Used to append additional content.
+         * @param object $category The current term object.
+         * @param int    $depth    Depth of the term in reference to parents. Default 0.
+         * @param array  $args     An array of arguments. @see wp_terms_checklist()
+         */
         function end_el( &$output, $category, $depth = 0, $args = array() ) {
                 $output .= "</li>\n";