sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/wp-content/themes/twentyfifteen/functions.php
View File

@ -144,20 +144,20 @@ if ( ! function_exists( 'twentyfifteen_setup' ) ) :
// 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(
'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(
'twentyfifteen_custom_background_args',
array(

30
src/wp-content/themes/twentyfifteen/inc/custom-header.php
View File

@ -16,23 +16,23 @@ function twentyfifteen_custom_header_setup() {
$color_scheme = twentyfifteen_get_color_scheme();
$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(
'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(
'twentyfifteen_custom_header_args',
array(

11
src/wp-content/themes/twentyfourteen/functions.php
View File

@ -169,6 +169,17 @@ if ( ! function_exists( 'twentyfourteen_setup' ) ) :
// This theme allows users to set a custom background.
add_theme_support(
'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(
'twentyfourteen_custom_background_args',
array(

36
src/wp-content/themes/twentyfourteen/inc/custom-header.php
View File

@ -17,26 +17,26 @@
* @uses twentyfourteen_admin_header_image()
*/
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(
'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(
'twentyfourteen_custom_header_args',
array(

34
src/wp-content/themes/twentyseventeen/inc/custom-header.php
View File

@ -16,25 +16,25 @@
*/
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(
'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(
'twentyseventeen_custom_header_args',
array(

54
src/wp-content/themes/twentysixteen/inc/customizer.php
View File

@ -19,19 +19,19 @@ function twentysixteen_custom_header_and_background() {
$default_background_color = trim( $color_scheme[0], '#' );
$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(
'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(
'twentysixteen_custom_background_args',
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(
'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(
'twentysixteen_custom_header_args',
array(

14
src/wp-content/themes/twentytwenty/template-parts/entry-header.php
View File

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