WordPress.org
Get WordPress

Make WordPress Core

Changeset 25641


Ignore:
Timestamp:
09/28/2013 06:01:26 PM (13 years ago)
Author:
DrewAPicture
Message:

Inline documentation improvements for Walker_Category and Walker_CategoryDropdown.

Also covers previously undocumented parameters.

See #23406, #19249.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r25310 r25641  
    764764class Walker_Category extends Walker {
    765765        /**
     766         * What the class handles.
     767         *
    766768         * @see Walker::$tree_type
    767769         * @since 2.1.0
    … …  
    771773
    772774        /**
     775         * Database fields to use.
     776         *
    773777         * @see Walker::$db_fields
    774778         * @since 2.1.0
    … …  
    779783
    780784        /**
     785         * Starts the list before the elements are added.
     786         *
    781787         * @see Walker::start_lvl()
     788         *
    782789         * @since 2.1.0
    783790         *
    784791         * @param string $output Passed by reference. Used to append additional content.
    785          * @param int $depth Depth of category. Used for tab indentation.
    786          * @param array $args Will only append content if style argument value is 'list'.
     792         * @param int    $depth  Depth of category. Used for tab indentation.
     793         * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
     794         *                       @see wp_list_categories()
    787795         */
    788796        function start_lvl( &$output, $depth = 0, $args = array() ) {
    … …  
    795803
    796804        /**
     805         * Ends the list of after the elements are added.
     806         *
    797807         * @see Walker::end_lvl()
     808         *
    798809         * @since 2.1.0
    799810         *
    800811         * @param string $output Passed by reference. Used to append additional content.
    801          * @param int $depth Depth of category. Used for tab indentation.
    802          * @param array $args Will only append content if style argument value is 'list'.
     812         * @param int    $depth  Depth of category. Used for tab indentation.
     813         * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
     814         *                       @wsee wp_list_categories()
    803815         */
    804816        function end_lvl( &$output, $depth = 0, $args = array() ) {
    … …  
    811823
    812824        /**
     825         * Start the element output.
     826         *
    813827         * @see Walker::start_el()
     828         *
    814829         * @since 2.1.0
    815830         *
    816          * @param string $output Passed by reference. Used to append additional content.
     831         * @param string $output   Passed by reference. Used to append additional content.
    817832         * @param object $category Category data object.
    818          * @param int $depth Depth of category in reference to parents.
    819          * @param array $args
     833         * @param int    $depth    Depth of category in reference to parents. Default 0.
     834         * @param array  $args     An array of arguments. @see wp_list_categories()
     835         * @param int    $id       ID of the current category.
    820836         */
    821837        function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
    … …  
    883899
    884900        /**
     901         * Ends the element output, if needed.
     902         *
    885903         * @see Walker::end_el()
     904         *
    886905         * @since 2.1.0
    887906         *
    888907         * @param string $output Passed by reference. Used to append additional content.
    889          * @param object $page Not used.
    890          * @param int $depth Depth of category. Not used.
    891          * @param array $args Only uses 'list' for whether should append to output.
     908         * @param object $page   Not used.
     909         * @param int    $depth Depth of category. Not used.
     910         * @param array  $args   An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories()
    892911         */
    893912        function end_el( &$output, $page, $depth = 0, $args = array() ) {
    … …  
    924943
    925944        /**
     945         * Start the element output.
     946         *
    926947         * @see Walker::start_el()
    927948         * @since 2.1.0
    928949         *
    929          * @param string $output Passed by reference. Used to append additional content.
     950         * @param string $output   Passed by reference. Used to append additional content.
    930951         * @param object $category Category data object.
    931          * @param int $depth Depth of category. Used for padding.
    932          * @param array $args Uses 'selected' and 'show_count' keys, if they exist.
     952         * @param int    $depth    Depth of category. Used for padding.
     953         * @param array  $args     Uses 'selected' and 'show_count' keys, if they exist. @see wp_dropdown_categories()
    933954         */
    934955        function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
Note: See TracChangeset for help on using the changeset viewer.