WordPress.org

Make WordPress Core

Changeset 37046


Ignore:
Timestamp:
03/22/2016 05:24:49 PM (6 years ago)
Author:
DrewAPicture
Message:

Docs: Improve inline documentation for property and methods in Walker_Category.

Props raimy for the initial patch.
See #36300.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-walker-category.php

    r36008 r37046  
    1616 */
    1717class Walker_Category extends Walker {
     18
    1819    /**
    1920     * What the class handles.
    2021     *
     22     * @since 2.1.0
     23     * @access public
     24     * @var string
     25     *
    2126     * @see Walker::$tree_type
    22      * @since 2.1.0
    23      * @var string
    2427     */
    2528    public $tree_type = 'category';
     
    2831     * Database fields to use.
    2932     *
    30      * @see Walker::$db_fields
    31      * @since 2.1.0
     33     * @since 2.1.0
     34     * @access public
    3235     * @todo Decouple this
    3336     * @var array
     37     *
     38     * @see Walker::$db_fields
    3439     */
    3540    public $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
     
    3843     * Starts the list before the elements are added.
    3944     *
     45     * @since 2.1.0
     46     * @access public
     47     *
    4048     * @see Walker::start_lvl()
    41      *
    42      * @since 2.1.0
    4349     *
    4450     * @param string $output Passed by reference. Used to append additional content.
    4551     * @param int    $depth  Depth of category. Used for tab indentation.
    4652     * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
    47      *                       @see wp_list_categories()
     53     *                       See wp_list_categories().
    4854     */
    4955    public function start_lvl( &$output, $depth = 0, $args = array() ) {
     
    5864     * Ends the list of after the elements are added.
    5965     *
     66     * @since 2.1.0
     67     * @access public
     68     *
    6069     * @see Walker::end_lvl()
    61      *
    62      * @since 2.1.0
    6370     *
    6471     * @param string $output Passed by reference. Used to append additional content.
    6572     * @param int    $depth  Depth of category. Used for tab indentation.
    6673     * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
    67      *                       @wsee wp_list_categories()
     74     *                       See wp_list_categories().
    6875     */
    6976    public function end_lvl( &$output, $depth = 0, $args = array() ) {
     
    7683
    7784    /**
    78      * Start the element output.
     85     * Starts the element output.
     86     *
     87     * @since 2.1.0
     88     * @access public
    7989     *
    8090     * @see Walker::start_el()
    81      *
    82      * @since 2.1.0
    8391     *
    8492     * @param string $output   Passed by reference. Used to append additional content.
    8593     * @param object $category Category data object.
    8694     * @param int    $depth    Depth of category in reference to parents. Default 0.
    87      * @param array  $args     An array of arguments. @see wp_list_categories()
     95     * @param array  $args     An array of arguments. See wp_list_categories().
    8896     * @param int    $id       ID of the current category.
    8997     */
     
    207215     * Ends the element output, if needed.
    208216     *
     217     * @since 2.1.0
     218     * @access public
     219     *
    209220     * @see Walker::end_el()
    210      *
    211      * @since 2.1.0
    212221     *
    213222     * @param string $output Passed by reference. Used to append additional content.
Note: See TracChangeset for help on using the changeset viewer.