WordPress.org

Make WordPress Core

Changeset 37047


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

Docs: Mark optional parameters in Walker_Category methods as such.

Also cleans up some syntax.

See #36300.

File:
1 edited

Legend:

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

    r37046 r37047  
    3333     * @since 2.1.0
    3434     * @access public
     35     * @var array
     36     *
     37     * @see Walker::$db_fields
    3538     * @todo Decouple this
    36      * @var array
    37      *
    38      * @see Walker::$db_fields
    3939     */
    4040    public $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
     
    4848     * @see Walker::start_lvl()
    4949     *
    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. Will only append content if style argument value is 'list'.
    53      *                       See wp_list_categories().
     50     * @param string $output Used to append additional content. Passed by reference.
     51     * @param int    $depth  Optional. Depth of category. Used for tab indentation. Default 0.
     52     * @param array  $args   Optional. An array of arguments. Will only append content if style argument
     53     *                       value is 'list'. See wp_list_categories(). Default empty array.
    5454     */
    5555    public function start_lvl( &$output, $depth = 0, $args = array() ) {
     
    6969     * @see Walker::end_lvl()
    7070     *
    71      * @param string $output Passed by reference. Used to append additional content.
    72      * @param int    $depth  Depth of category. Used for tab indentation.
    73      * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
    74      *                       See wp_list_categories().
     71     * @param string $output Used to append additional content. Passed by reference.
     72     * @param int    $depth  Optional. Depth of category. Used for tab indentation. Default 0.
     73     * @param array  $args   Optional. An array of arguments. Will only append content if style argument
     74     *                       value is 'list'. See wp_list_categories(). Default empty array.
    7575     */
    7676    public function end_lvl( &$output, $depth = 0, $args = array() ) {
     
    9292     * @param string $output   Passed by reference. Used to append additional content.
    9393     * @param object $category Category data object.
    94      * @param int    $depth    Depth of category in reference to parents. Default 0.
    95      * @param array  $args     An array of arguments. See wp_list_categories().
    96      * @param int    $id       ID of the current category.
     94     * @param int    $depth    Optional. Depth of category in reference to parents. Default 0.
     95     * @param array  $args     Optional. An array of arguments. See wp_list_categories(). Default empty array.
     96     * @param int    $id       Optional. ID of the current category. Default 0.
    9797     */
    9898    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
     
    222222     * @param string $output Passed by reference. Used to append additional content.
    223223     * @param object $page   Not used.
    224      * @param int    $depth  Depth of category. Not used.
    225      * @param array  $args   An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories()
     224     * @param int    $depth  Optional. Depth of category. Not used.
     225     * @param array  $args   Optional. An array of arguments. Only uses 'list' for whether should append
     226     *                       to output. See wp_list_categories(). Default empty array.
    226227     */
    227228    public function end_el( &$output, $page, $depth = 0, $args = array() ) {
Note: See TracChangeset for help on using the changeset viewer.