WordPress.org

Make WordPress Core

Changeset 25642


Ignore:
Timestamp:
09/28/2013 06:07:02 PM (8 years ago)
Author:
DrewAPicture
Message:

Inline documentation for Walker_Category_Checklist.

See #23406.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/template.php

    r25591 r25642  
    2525    var $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); //TODO: decouple this
    2626
     27    /**
     28     * Starts the list before the elements are added.
     29     *
     30     * @see Walker:start_lvl()
     31     *
     32     * @since 2.5.1
     33     *
     34     * @param string $output Passed by reference. Used to append additional content.
     35     * @param int    $depth  Depth of category. Used for tab indentation.
     36     * @param array  $args   An array of arguments. @see wp_terms_checklist()
     37     */
    2738    function start_lvl( &$output, $depth = 0, $args = array() ) {
    2839        $indent = str_repeat("\t", $depth);
     
    3041    }
    3142
     43    /**
     44     * Ends the list of after the elements are added.
     45     *
     46     * @see Walker::end_lvl()
     47     *
     48     * @since 2.5.1
     49     *
     50     * @param string $output Passed by reference. Used to append additional content.
     51     * @param int    $depth  Depth of category. Used for tab indentation.
     52     * @param array  $args   An array of arguments. @see wp_terms_checklist()
     53     */
    3254    function end_lvl( &$output, $depth = 0, $args = array() ) {
    3355        $indent = str_repeat("\t", $depth);
     
    3557    }
    3658
     59    /**
     60     * Start the element output.
     61     *
     62     * @see Walker::start_el()
     63     *
     64     * @since 2.5.1
     65     *
     66     * @param string $output   Passed by reference. Used to append additional content.
     67     * @param object $category The current term object.
     68     * @param int    $depth    Depth of the term in reference to parents. Default 0.
     69     * @param array  $args     An array of arguments. @see wp_terms_checklist()
     70     * @param int    $id       ID of the current term.
     71     */
    3772    function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
    3873        extract($args);
     
    4984    }
    5085
     86    /**
     87     * Ends the element output, if needed.
     88     *
     89     * @see Walker::end_el()
     90     *
     91     * @since 2.5.1
     92     *
     93     * @param string $output   Passed by reference. Used to append additional content.
     94     * @param object $category The current term object.
     95     * @param int    $depth    Depth of the term in reference to parents. Default 0.
     96     * @param array  $args     An array of arguments. @see wp_terms_checklist()
     97     */
    5198    function end_el( &$output, $category, $depth = 0, $args = array() ) {
    5299        $output .= "</li>\n";
Note: See TracChangeset for help on using the changeset viewer.