WordPress.org

Make WordPress Core

Changeset 48264


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

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

See #49572.

Location:
trunk/src/wp-content/themes
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-content/themes/twentyfifteen/functions.php

    r48103 r48264  
    145145        // Setup the WordPress core custom background feature.
    146146
    147         /**
    148          * Filter Twenty Fifteen custom-header support arguments.
    149          *
    150          * @since Twenty Fifteen 1.0
    151          *
    152          * @param array $args {
    153          *     An array of custom-header support arguments.
    154          *
    155          *     @type string $default-color          Default color of the header.
    156          *     @type string $default-attachment     Default attachment of the header.
    157          * }
    158          */
    159147        add_theme_support(
    160148            'custom-background',
     149            /**
     150             * Filter Twenty Fifteen custom-background support arguments.
     151             *
     152             * @since Twenty Fifteen 1.0
     153             *
     154             * @param array $args {
     155             *     An array of custom-background support arguments.
     156             *
     157             *     @type string $default-color      Default color of the background.
     158             *     @type string $default-attachment Default attachment of the background.
     159             * }
     160             */
    161161            apply_filters(
    162162                'twentyfifteen_custom_background_args',
  • trunk/src/wp-content/themes/twentyfifteen/inc/custom-header.php

    r47122 r48264  
    1717    $default_text_color = trim( $color_scheme[4], '#' );
    1818
    19     /**
    20      * Filter Twenty Fifteen custom-header support arguments.
    21      *
    22      * @since Twenty Fifteen 1.0
    23      *
    24      * @param array $args {
    25      *     An array of custom-header support arguments.
    26      *
    27      *     @type string $default_text_color     Default color of the header text.
    28      *     @type int    $width                  Width in pixels of the custom header image. Default 954.
    29      *     @type int    $height                 Height in pixels of the custom header image. Default 1300.
    30      *     @type string $wp-head-callback       Callback function used to styles the header image and text
    31      *                                          displayed on the blog.
    32      * }
    33      */
    3419    add_theme_support(
    3520        'custom-header',
     21        /**
     22         * Filter Twenty Fifteen custom-header support arguments.
     23         *
     24         * @since Twenty Fifteen 1.0
     25         *
     26         * @param array $args {
     27         *     An array of custom-header support arguments.
     28         *
     29         *     @type string $default_text_color Default color of the header text.
     30         *     @type int    $width              Width in pixels of the custom header image. Default 954.
     31         *     @type int    $height             Height in pixels of the custom header image. Default 1300.
     32         *     @type string $wp-head-callback   Callback function used to styles the header image and text
     33         *                                      displayed on the blog.
     34         * }
     35         */
    3636        apply_filters(
    3737            'twentyfifteen_custom_header_args',
  • trunk/src/wp-content/themes/twentyfourteen/functions.php

    r47808 r48264  
    170170        add_theme_support(
    171171            'custom-background',
     172            /**
     173             * Filter Twenty Fourteen custom-background support arguments.
     174             *
     175             * @since Twenty Fourteen 1.0
     176             *
     177             * @param array $args {
     178             *     An array of custom-background support arguments.
     179             *
     180             *     @type string $default-color Default color of the background.
     181             * }
     182             */
    172183            apply_filters(
    173184                'twentyfourteen_custom_background_args',
  • trunk/src/wp-content/themes/twentyfourteen/inc/custom-header.php

    r47219 r48264  
    1818 */
    1919function twentyfourteen_custom_header_setup() {
    20     /**
    21      * Filter Twenty Fourteen custom-header support arguments.
    22      *
    23      * @since Twenty Fourteen 1.0
    24      *
    25      * @param array $args {
    26      *     An array of custom-header support arguments.
    27      *
    28      *     @type bool   $header_text            Whether to display custom header text. Default false.
    29      *     @type int    $width                  Width in pixels of the custom header image. Default 1260.
    30      *     @type int    $height                 Height in pixels of the custom header image. Default 240.
    31      *     @type bool   $flex_height            Whether to allow flexible-height header images. Default true.
    32      *     @type string $admin_head_callback    Callback function used to style the image displayed in
    33      *                                          the Appearance > Header screen.
    34      *     @type string $admin_preview_callback Callback function used to create the custom header markup in
    35      *                                          the Appearance > Header screen.
    36      * }
    37      */
    3820    add_theme_support(
    3921        'custom-header',
     22        /**
     23         * Filter Twenty Fourteen custom-header support arguments.
     24         *
     25         * @since Twenty Fourteen 1.0
     26         *
     27         * @param array $args {
     28         *     An array of custom-header support arguments.
     29         *
     30         *     @type bool   $header_text            Whether to display custom header text. Default false.
     31         *     @type int    $width                  Width in pixels of the custom header image. Default 1260.
     32         *     @type int    $height                 Height in pixels of the custom header image. Default 240.
     33         *     @type bool   $flex_height            Whether to allow flexible-height header images. Default true.
     34         *     @type string $admin_head_callback    Callback function used to style the image displayed in
     35         *                                          the Appearance > Header screen.
     36         *     @type string $admin_preview_callback Callback function used to create the custom header markup in
     37         *                                          the Appearance > Header screen.
     38         * }
     39         */
    4040        apply_filters(
    4141            'twentyfourteen_custom_header_args',
  • trunk/src/wp-content/themes/twentyseventeen/inc/custom-header.php

    r47122 r48264  
    1717function twentyseventeen_custom_header_setup() {
    1818
    19     /**
    20      * Filter Twenty Seventeen custom-header support arguments.
    21      *
    22      * @since Twenty Seventeen 1.0
    23      *
    24      * @param array $args {
    25      *     An array of custom-header support arguments.
    26      *
    27      *     @type string $default-image          Default image of the header.
    28      *     @type int    $width                  Width in pixels of the custom header image. Default 954.
    29      *     @type int    $height                 Height in pixels of the custom header image. Default 1300.
    30      *     @type string $flex-height            Flex support for height of header.
    31      *     @type string $video                  Video support for header.
    32      *     @type string $wp-head-callback       Callback function used to styles the header image and text
    33      *                                          displayed on the blog.
    34      * }
    35      */
    3619    add_theme_support(
    3720        'custom-header',
     21        /**
     22         * Filter Twenty Seventeen custom-header support arguments.
     23         *
     24         * @since Twenty Seventeen 1.0
     25         *
     26         * @param array $args {
     27         *     An array of custom-header support arguments.
     28         *
     29         *     @type string $default-image    Default image of the header.
     30         *     @type int    $width            Width in pixels of the custom header image. Default 954.
     31         *     @type int    $height           Height in pixels of the custom header image. Default 1300.
     32         *     @type string $flex-height      Flex support for height of header.
     33         *     @type string $video            Video support for header.
     34         *     @type string $wp-head-callback Callback function used to styles the header image and text
     35         *                                    displayed on the blog.
     36         * }
     37         */
    3838        apply_filters(
    3939            'twentyseventeen_custom_header_args',
  • 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',
  • trunk/src/wp-content/themes/twentytwenty/template-parts/entry-header.php

    r47122 r48264  
    2121
    2222        <?php
    23             /**
    24             * Allow child themes and plugins to filter the display of the categories in the entry header.
    25             *
    26             * @since Twenty Twenty 1.0
    27             *
    28             * @param bool   Whether to show the categories in header, Default true.
    29             */
     23        /**
     24        * Allow child themes and plugins to filter the display of the categories in the entry header.
     25        *
     26        * @since Twenty Twenty 1.0
     27        *
     28        * @param bool   Whether to show the categories in header, Default true.
     29        */
    3030        $show_categories = apply_filters( 'twentytwenty_show_categories_in_entry_header', true );
    3131
Note: See TracChangeset for help on using the changeset viewer.