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

See #49572.
Built from https://develop.svn.wordpress.org/trunk@48264


git-svn-id: http://core.svn.wordpress.org/trunk@48033 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-07-01 13:52:01 +00:00
parent 9a9352da00
commit 30e0cf9fcd
8 changed files with 108 additions and 97 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.
/**
* Filter Twenty Fifteen custom-header support arguments.
*
* @since Twenty Fifteen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type string $default-color Default color of the header.
* @type string $default-attachment Default attachment of the header.
* }
*/
add_theme_support( add_theme_support(
'custom-background', 'custom-background',
/**
* Filter Twenty Fifteen custom-background support arguments.
*
* @since Twenty Fifteen 1.0
*
* @param array $args {
* An array of custom-background support arguments.
*
* @type string $default-color Default color of the background.
* @type string $default-attachment Default attachment of the background.
* }
*/
apply_filters( apply_filters(
'twentyfifteen_custom_background_args', 'twentyfifteen_custom_background_args',
array( array(

View File

@ -16,23 +16,23 @@ 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], '#' );
/**
* Filter Twenty Fifteen custom-header support arguments.
*
* @since Twenty Fifteen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type string $default_text_color Default color of the header text.
* @type int $width Width in pixels of the custom header image. Default 954.
* @type int $height Height in pixels of the custom header image. Default 1300.
* @type string $wp-head-callback Callback function used to styles the header image and text
* displayed on the blog.
* }
*/
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/**
* Filter Twenty Fifteen custom-header support arguments.
*
* @since Twenty Fifteen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type string $default_text_color Default color of the header text.
* @type int $width Width in pixels of the custom header image. Default 954.
* @type int $height Height in pixels of the custom header image. Default 1300.
* @type string $wp-head-callback Callback function used to styles the header image and text
* displayed on the blog.
* }
*/
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,26 +17,26 @@
* @uses twentyfourteen_admin_header_image() * @uses twentyfourteen_admin_header_image()
*/ */
function twentyfourteen_custom_header_setup() { function twentyfourteen_custom_header_setup() {
/**
* Filter Twenty Fourteen custom-header support arguments.
*
* @since Twenty Fourteen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type bool $header_text Whether to display custom header text. Default false.
* @type int $width Width in pixels of the custom header image. Default 1260.
* @type int $height Height in pixels of the custom header image. Default 240.
* @type bool $flex_height Whether to allow flexible-height header images. Default true.
* @type string $admin_head_callback Callback function used to style the image displayed in
* the Appearance > Header screen.
* @type string $admin_preview_callback Callback function used to create the custom header markup in
* the Appearance > Header screen.
* }
*/
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/**
* Filter Twenty Fourteen custom-header support arguments.
*
* @since Twenty Fourteen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type bool $header_text Whether to display custom header text. Default false.
* @type int $width Width in pixels of the custom header image. Default 1260.
* @type int $height Height in pixels of the custom header image. Default 240.
* @type bool $flex_height Whether to allow flexible-height header images. Default true.
* @type string $admin_head_callback Callback function used to style the image displayed in
* the Appearance > Header screen.
* @type string $admin_preview_callback Callback function used to create the custom header markup in
* the Appearance > Header screen.
* }
*/
apply_filters( apply_filters(
'twentyfourteen_custom_header_args', 'twentyfourteen_custom_header_args',
array( array(

View File

@ -16,25 +16,25 @@
*/ */
function twentyseventeen_custom_header_setup() { function twentyseventeen_custom_header_setup() {
/**
* Filter Twenty Seventeen custom-header support arguments.
*
* @since Twenty Seventeen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type string $default-image Default image of the header.
* @type int $width Width in pixels of the custom header image. Default 954.
* @type int $height Height in pixels of the custom header image. Default 1300.
* @type string $flex-height Flex support for height of header.
* @type string $video Video support for header.
* @type string $wp-head-callback Callback function used to styles the header image and text
* displayed on the blog.
* }
*/
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/**
* Filter Twenty Seventeen custom-header support arguments.
*
* @since Twenty Seventeen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type string $default-image Default image of the header.
* @type int $width Width in pixels of the custom header image. Default 954.
* @type int $height Height in pixels of the custom header image. Default 1300.
* @type string $flex-height Flex support for height of header.
* @type string $video Video support for header.
* @type string $wp-head-callback Callback function used to styles the header image and text
* displayed on the blog.
* }
*/
apply_filters( apply_filters(
'twentyseventeen_custom_header_args', 'twentyseventeen_custom_header_args',
array( array(

View File

@ -19,19 +19,19 @@ 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], '#' );
/**
* Filter the arguments used when adding 'custom-background' support in Twenty Sixteen.
*
* @since Twenty Sixteen 1.0
*
* @param array $args {
* An array of custom-background support arguments.
*
* @type string $default-color Default color of the background.
* }
*/
add_theme_support( add_theme_support(
'custom-background', 'custom-background',
/**
* Filter the arguments used when adding 'custom-background' support in Twenty Sixteen.
*
* @since Twenty Sixteen 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(
'twentysixteen_custom_background_args', 'twentysixteen_custom_background_args',
array( array(
@ -40,24 +40,24 @@ function twentysixteen_custom_header_and_background() {
) )
); );
/**
* Filter the arguments used when adding 'custom-header' support in Twenty Sixteen.
*
* @since Twenty Sixteen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type string $default-text-color Default color of the header text.
* @type int $width Width in pixels of the custom header image. Default 1200.
* @type int $height Height in pixels of the custom header image. Default 280.
* @type bool $flex-height Whether to allow flexible-height header images. Default true.
* @type callable $wp-head-callback Callback function used to style the header image and text
* displayed on the blog.
* }
*/
add_theme_support( add_theme_support(
'custom-header', 'custom-header',
/**
* Filter the arguments used when adding 'custom-header' support in Twenty Sixteen.
*
* @since Twenty Sixteen 1.0
*
* @param array $args {
* An array of custom-header support arguments.
*
* @type string $default-text-color Default color of the header text.
* @type int $width Width in pixels of the custom header image. Default 1200.
* @type int $height Height in pixels of the custom header image. Default 280.
* @type bool $flex-height Whether to allow flexible-height header images. Default true.
* @type callable $wp-head-callback Callback function used to style the header image and text
* displayed on the blog.
* }
*/
apply_filters( apply_filters(
'twentysixteen_custom_header_args', 'twentysixteen_custom_header_args',
array( array(

View File

@ -20,13 +20,13 @@ if ( is_singular() ) {
<div class="entry-header-inner section-inner medium"> <div class="entry-header-inner section-inner medium">
<?php <?php
/** /**
* Allow child themes and plugins to filter the display of the categories in the entry header. * Allow child themes and plugins to filter the display of the categories in the entry header.
* *
* @since Twenty Twenty 1.0 * @since Twenty Twenty 1.0
* *
* @param bool Whether to show the categories in header, Default true. * @param bool Whether to show the categories in header, Default true.
*/ */
$show_categories = apply_filters( 'twentytwenty_show_categories_in_entry_header', true ); $show_categories = apply_filters( 'twentytwenty_show_categories_in_entry_header', true );
if ( true === $show_categories && has_category() ) { if ( true === $show_categories && has_category() ) {

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.5-alpha-48263'; $wp_version = '5.5-alpha-48264';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.