WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/01/2020 01:50:28 PM (5 years ago)
Author:
SergeyBiryukov
Message:

Docs: Bundled Themes: Correct DocBlock placement for custom header and background argument filters.

See #49572.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-content/themes/twentysixteen/inc/customizer.php

    r48067 r48264  
    2020    $default_text_color       = trim( $color_scheme[3], '#' );
    2121
    22     /**
    23      * Filter the arguments used when adding 'custom-background' support in Twenty Sixteen.
    24      *
    25      * @since Twenty Sixteen 1.0
    26      *
    27      * @param array $args {
    28      *     An array of custom-background support arguments.
    29      *
    30      *     @type string $default-color Default color of the background.
    31      * }
    32      */
    3322    add_theme_support(
    3423        'custom-background',
     24        /**
     25         * Filter the arguments used when adding 'custom-background' support in Twenty Sixteen.
     26         *
     27         * @since Twenty Sixteen 1.0
     28         *
     29         * @param array $args {
     30         *     An array of custom-background support arguments.
     31         *
     32         *     @type string $default-color Default color of the background.
     33         * }
     34         */
    3535        apply_filters(
    3636            'twentysixteen_custom_background_args',
    … …  
    4141    );
    4242
    43     /**
    44      * Filter the arguments used when adding 'custom-header' support in Twenty Sixteen.
    45      *
    46      * @since Twenty Sixteen 1.0
    47      *
    48      * @param array $args {
    49      *     An array of custom-header support arguments.
    50      *
    51      *     @type string $default-text-color Default color of the header text.
    52      *     @type int      $width            Width in pixels of the custom header image. Default 1200.
    53      *     @type int      $height           Height in pixels of the custom header image. Default 280.
    54      *     @type bool     $flex-height      Whether to allow flexible-height header images. Default true.
    55      *     @type callable $wp-head-callback Callback function used to style the header image and text
    56      *                                      displayed on the blog.
    57      * }
    58      */
    5943    add_theme_support(
    6044        'custom-header',
     45        /**
     46         * Filter the arguments used when adding 'custom-header' support in Twenty Sixteen.
     47         *
     48         * @since Twenty Sixteen 1.0
     49         *
     50         * @param array $args {
     51         *     An array of custom-header support arguments.
     52         *
     53         *     @type string   $default-text-color Default color of the header text.
     54         *     @type int      $width              Width in pixels of the custom header image. Default 1200.
     55         *     @type int      $height             Height in pixels of the custom header image. Default 280.
     56         *     @type bool     $flex-height        Whether to allow flexible-height header images. Default true.
     57         *     @type callable $wp-head-callback   Callback function used to style the header image and text
     58         *                                        displayed on the blog.
     59         * }
     60         */
    6161        apply_filters(
    6262            'twentysixteen_custom_header_args',
Note: See TracChangeset for help on using the changeset viewer.