WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_theme_support()

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

In this article

Back to top

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'
  • 'appearance-tools'
  • 'automatic-feed-links'
  • 'block-templates'
  • 'block-template-parts'
  • 'border'
  • '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'
  • 'disable-custom-gradients'
  • 'disable-layout-styles'
  • 'editor-color-palette'
  • 'editor-gradient-presets'
  • 'editor-font-sizes'
  • 'editor-spacing-sizes'
  • 'editor-styles'
  • 'featured-content'
  • 'html5'
  • 'link-color'
  • 'menus'
  • 'post-formats'
  • 'post-thumbnails'
  • 'responsive-embeds'
  • 'starter-content'
  • 'title-tag'
  • 'widgets'
  • 'widgets-block-editor'
  • 'wp-block-styles'
$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 ];
	}
}

View all references View on Trac View on GitHub

Used byDescription
_load_remote_featured_patterns()wp-includes/block-patterns.php

Register Featured (category) patterns from wordpress.org/patterns.

_load_remote_block_patterns()wp-includes/block-patterns.php

Register Core’s official patterns from wordpress.org/patterns.

_register_core_block_patterns_and_categories()wp-includes/block-patterns.php

Registers the core block patterns and categories.

WP_REST_Themes_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php

Prepares a single theme output for response.

get_theme_starter_content()wp-includes/theme.php

Expands a theme’s starter content configuration using core-provided data.

is_header_video_active()wp-includes/theme.php

Checks whether the custom header video is eligible to show on the current page.

_custom_logo_header_styles()wp-includes/theme.php

Adds CSS to hide header text for custom logo, based on Customizer setting.

get_custom_logo()wp-includes/general-template.php

Returns a custom logo, linked to home unless the theme supports removing the link on the home page.

WP_Customize_Background_Image_Control::enqueue()wp-includes/customize/class-wp-customize-background-image-control.php

Enqueue control related scripts/styles.

post_format_meta_box()wp-admin/includes/meta-boxes.php

Displays post format form elements.

get_background_color()wp-includes/theme.php

Retrieves value for custom background color.

_custom_background_cb()wp-includes/theme.php

Default custom background callback.

add_theme_support()wp-includes/theme.php

Registers theme support for a given feature.

_custom_header_background_just_in_time()wp-includes/theme.php

Registers the internal custom header and background routines.

_remove_theme_support()wp-includes/theme.php

Do not use. Removes theme support internally without knowledge of those not used by themes directly.

get_header_textcolor()wp-includes/theme.php

Retrieves the custom header text color in 3- or 6-digit hexadecimal form.

display_header_text()wp-includes/theme.php

Whether to display the header text.

get_header_image()wp-includes/theme.php

Retrieves header image for custom header.

is_random_header_image()wp-includes/theme.php

Checks if random header image is in use.

get_custom_header()wp-includes/theme.php

Gets the header image data.

get_background_image()wp-includes/theme.php

Retrieves background image for custom background.

WP_Customize_Header_Image_Setting::update()wp-includes/customize/class-wp-customize-header-image-setting.php
get_body_class()wp-includes/post-template.php

Retrieves an array of the class names for the body element.

WP_Customize_Header_Image_Control::enqueue()wp-includes/customize/class-wp-customize-header-image-control.php
WP_Customize_Header_Image_Control::render_content()wp-includes/customize/class-wp-customize-header-image-control.php
Show 20 moreShow less

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
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    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.