get_theme_support( string $feature, mixed $args ): mixed

Gets the theme support arguments passed when registering that support.

Description

Example usage:

get_theme_support( 'custom-logo' );
get_theme_support( 'custom-header', 'width' );

Parameters

$featurestringrequired
The feature to check. See add_theme_support() for the list of possible values.
More Arguments from add_theme_support( … $feature )The feature being added. Likely core values include:
  • 'admin-bar'
  • 'align-wide'
  • 'automatic-feed-links'
  • 'core-block-patterns'
  • 'custom-background'
  • 'custom-header'
  • 'custom-line-height'
  • 'custom-logo'
  • 'customize-selective-refresh-widgets'
  • 'custom-spacing'
  • 'custom-units'
  • 'dark-editor-style'
  • 'disable-custom-colors'
  • 'disable-custom-font-sizes'
  • 'editor-color-palette'
  • 'editor-gradient-presets'
  • 'editor-font-sizes'
  • 'editor-styles'
  • 'featured-content'
  • 'html5'
  • 'menus'
  • 'post-formats'
  • 'post-thumbnails'
  • 'responsive-embeds'
  • 'starter-content'
  • 'title-tag'
  • 'wp-block-styles'
  • 'widgets'
  • 'widgets-block-editor'
$argsmixedoptional
Optional extra arguments to be checked against certain features.

Return

mixed The array of extra arguments or the value for the registered feature.

Source

function get_theme_support( $feature, ...$args ) {
	global $_wp_theme_features;

	if ( ! isset( $_wp_theme_features[ $feature ] ) ) {
		return false;
	}

	if ( ! $args ) {
		return $_wp_theme_features[ $feature ];
	}

	switch ( $feature ) {
		case 'custom-logo':
		case 'custom-header':
		case 'custom-background':
			if ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) ) {
				return $_wp_theme_features[ $feature ][0][ $args[0] ];
			}
			return false;

		default:
			return $_wp_theme_features[ $feature ];
	}
}

Changelog

VersionDescription
5.3.0Formalized the existing and already documented ...$args parameter by adding it to the function signature.
3.1.0Introduced.

User Contributed Notes

  1. Skip to note 2 content

    Gets the `custom-background` theme support arguments

    $theme_support = get_theme_support( 'custom-background' );

    Output:

    Array
    (
        [0] => Array
            (
                [default-image] =>
                [default-repeat] => repeat
                [default-position-x] => left
                [default-attachment] => scroll
                [default-color] => ffffff
                [wp-head-callback] => _custom_background_cb
                [admin-head-callback] =>
                [admin-preview-callback] =>
            )
    
    )

You must log in before being able to contribute a note or feedback.