wppaste
WordPress

apply_filters( 'twentyseventeen_custom_header_args', array $args )

Since
Twenty Seventeen 1.0
Filters Twenty Seventeen custom-header support arguments.

Compatibility

WordPress
since Twenty Seventeen 1.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$argsarray
{ 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.
}
  • $default-imagestring

    Default image of the header.
  • $widthint

    Width in pixels of the custom header image. Default 954.
  • $heightint

    Height in pixels of the custom header image. Default 1300.
  • $flex-heightstring

    Flex support for height of header.
  • $videostring

    Video support for header.
  • $wp-head-callbackstring

    Callback function used to styles the header image and text displayed on the blog.

Where this hook fires · 1

  • wp-content/themes/twentyseventeen/inc/custom-header.php:38twentyseventeen_custom_header_setup()

Source code

		 *     @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(				'default-image'    => get_parent_theme_file_uri( '/assets/images/header.jpg' ),				'width'            => 2000,				'height'           => 1200,				'flex-height'      => true,

Changelog

Introduced in Twenty Seventeen 1.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.