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

See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@48264 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-01 13:50:28 +00:00
parent a425f15dd7
commit 28cb0c2049
7 changed files with 107 additions and 96 deletions

View File

@ -144,20 +144,20 @@ if ( ! function_exists( 'twentyfifteen_setup' ) ) :
// Setup the WordPress core custom background feature. // Setup the WordPress core custom background feature.
add_theme_support(
'custom-background',
/** /**
* Filter Twenty Fifteen custom-header support arguments. * Filter Twenty Fifteen custom-background support arguments.
* *
* @since Twenty Fifteen 1.0 * @since Twenty Fifteen 1.0
* *
* @param array $args { * @param array $args {
* An array of custom-header support arguments. * An array of custom-background support arguments.
* *
* @type string $default-color Default color of the header. * @type string $default-color Default color of the background.
* @type string $default-attachment Default attachment of the header. * @type string $default-attachment Default attachment of the background.
* } * }
*/ */
add_theme_support(
'custom-background',
apply_filters( apply_filters(
'twentyfifteen_custom_background_args', 'twentyfifteen_custom_background_args',
array( array(

View File

@ -16,6 +16,8 @@ function twentyfifteen_custom_header_setup() {
$color_scheme = twentyfifteen_get_color_scheme(); $color_scheme = twentyfifteen_get_color_scheme();
$default_text_color = trim( $color_scheme[4], '#' ); $default_text_color = trim( $color_scheme[4], '#' );
add_theme_support(
'custom-header',
/** /**
* Filter Twenty Fifteen custom-header support arguments. * Filter Twenty Fifteen custom-header support arguments.
* *
@ -31,8 +33,6 @@ function twentyfifteen_custom_header_setup() {
* displayed on the blog. * displayed on the blog.
* } * }
*/ */
add_theme_support(
'custom-header',
apply_filters( apply_filters(
'twentyfifteen_custom_header_args', 'twentyfifteen_custom_header_args',
array( array(

View File

@ -169,6 +169,17 @@ if ( ! function_exists( 'twentyfourteen_setup' ) ) :
// This theme allows users to set a custom background. // This theme allows users to set a custom background.
add_theme_support( add_theme_support(
'custom-background', 'custom-background',
/**
* Filter Twenty Fourteen custom-background support arguments.
*
* @since Twenty Fourteen 1.0
*
* @param array $args {
* An array of custom-background support arguments.
*
* @type string $default-color Default color of the background.
* }
*/
apply_filters( apply_filters(
'twentyfourteen_custom_background_args', 'twentyfourteen_custom_background_args',
array( array(

View File

@ -17,6 +17,8 @@
* @uses twentyfourteen_admin_header_image() * @uses twentyfourteen_admin_header_image()
*/ */
function twentyfourteen_custom_header_setup() { function twentyfourteen_custom_header_setup() {
add_theme_support(
'custom-header',
/** /**
* Filter Twenty Fourteen custom-header support arguments. * Filter Twenty Fourteen custom-header support arguments.
* *
@ -35,8 +37,6 @@ function twentyfourteen_custom_header_setup() {
* the Appearance > Header screen. * the Appearance > Header screen.
* } * }
*/ */
add_theme_support(
'custom-header',
apply_filters( apply_filters(
'twentyfourteen_custom_header_args', 'twentyfourteen_custom_header_args',
array( array(

View File

@ -16,6 +16,8 @@
*/ */
function twentyseventeen_custom_header_setup() { function twentyseventeen_custom_header_setup() {
add_theme_support(
'custom-header',
/** /**
* Filter Twenty Seventeen custom-header support arguments. * Filter Twenty Seventeen custom-header support arguments.
* *
@ -33,8 +35,6 @@ function twentyseventeen_custom_header_setup() {
* displayed on the blog. * displayed on the blog.
* } * }
*/ */
add_theme_support(
'custom-header',
apply_filters( apply_filters(
'twentyseventeen_custom_header_args', 'twentyseventeen_custom_header_args',
array( array(

View File

@ -19,6 +19,8 @@ function twentysixteen_custom_header_and_background() {
$default_background_color = trim( $color_scheme[0], '#' ); $default_background_color = trim( $color_scheme[0], '#' );
$default_text_color = trim( $color_scheme[3], '#' ); $default_text_color = trim( $color_scheme[3], '#' );
add_theme_support(
'custom-background',
/** /**
* Filter the arguments used when adding 'custom-background' support in Twenty Sixteen. * Filter the arguments used when adding 'custom-background' support in Twenty Sixteen.
* *
@ -30,8 +32,6 @@ function twentysixteen_custom_header_and_background() {
* @type string $default-color Default color of the background. * @type string $default-color Default color of the background.
* } * }
*/ */
add_theme_support(
'custom-background',
apply_filters( apply_filters(
'twentysixteen_custom_background_args', 'twentysixteen_custom_background_args',
array( array(
@ -40,6 +40,8 @@ function twentysixteen_custom_header_and_background() {
) )
); );
add_theme_support(
'custom-header',
/** /**
* Filter the arguments used when adding 'custom-header' support in Twenty Sixteen. * Filter the arguments used when adding 'custom-header' support in Twenty Sixteen.
* *
@ -56,8 +58,6 @@ function twentysixteen_custom_header_and_background() {
* displayed on the blog. * displayed on the blog.
* } * }
*/ */
add_theme_support(
'custom-header',
apply_filters( apply_filters(
'twentysixteen_custom_header_args', 'twentysixteen_custom_header_args',
array( array(