get_theme_support( string $feature, mixed $args )

Gets the theme support arguments passed when registering that support.

Contents

Description Description

Example usage:

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

Top ↑

Parameters Parameters

$feature

(string) (Required) The feature to check. See add_theme_support() for the list of possible values.

$args

(mixed) (Optional) extra arguments to be checked against certain features.

Top ↑

Return Return

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

Top ↑

Source Source

File: wp-includes/theme.php 

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 ];
	}
}

Expand full source code Collapse full source code View on Trac

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/block-patterns.php: _load_remote_block_patterns()

Register Core’s official patterns from wordpress.org/patterns.
wp-includes/block-editor.php: get_default_block_editor_settings()

Returns the default block editor settings.
wp-includes/widgets.php: wp_use_widgets_block_editor()

Whether or not to use the block editor to manage widgets. Defaults to true unless a theme has removed support for widgets-block-editor or a plugin has filtered the return value of this function.
wp-includes/class-wp-theme-json.php: WP_Theme_JSON::get_from_editor_settings()

Transforms the given editor settings according the add_theme_support format to the theme.json format.
wp-admin/includes/template.php: get_media_states()

Retrieves an array of media states from an attachment.
wp-includes/block-patterns.php: _register_core_block_patterns_and_categories()

Registers the core block patterns and categories.
wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php: WP_REST_Themes_Controller::prepare_item_for_response()

Prepares a single theme output for response.
wp-includes/theme.php: get_theme_starter_content()

Expands a theme’s starter content configuration using core-provided data.
wp-includes/theme.php: is_header_video_active()

Checks whether the custom header video is eligible to show on the current page.
wp-includes/theme.php: _custom_logo_header_styles()

Adds CSS to hide header text for custom logo, based on Customizer setting.
wp-includes/general-template.php: get_custom_logo()

Returns a custom logo, linked to home unless the theme supports removing the link on the home page.
wp-includes/customize/class-wp-customize-background-image-control.php: WP_Customize_Background_Image_Control::enqueue()

Enqueue control related scripts/styles.
wp-admin/includes/meta-boxes.php: post_format_meta_box()

Display post format form elements.
wp-admin/includes/class-wp-posts-list-table.php: WP_Posts_List_Table::inline_edit()

Outputs the hidden row displayed when inline editing
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::get_header_dimensions()

Calculate width and height based on what the currently selected theme supports.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::get_default_header_images()

Gets the details of default header images if defined.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_1()

Display first step of custom header image page.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_2()

Display second step of custom header image page.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::reset_header_image()

Reset a header image to the default image for the theme.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::js_1()

Display JavaScript based on Step 1 and 3.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::js_2()

Display JavaScript based on Step 2.
wp-admin/includes/class-custom-background.php: Custom_Background::admin_page()

Display the custom background page.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::register_controls()

Register some default controls.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::_sanitize_header_textcolor()

Callback for validating the header_textcolor value.
wp-includes/theme.php: get_background_color()

Retrieves value for custom background color.
wp-includes/theme.php: _custom_background_cb()

Default custom background callback.
wp-includes/theme.php: add_theme_support()

Registers theme support for a given feature.
wp-includes/theme.php: _custom_header_background_just_in_time()

Registers the internal custom header and background routines.
wp-includes/theme.php: _remove_theme_support()

Do not use. Removes theme support internally without knowledge of those not used by themes directly.
wp-includes/theme.php: get_header_textcolor()

Retrieves the custom header text color in 3- or 6-digit hexadecimal form.
wp-includes/theme.php: display_header_text()

Whether to display the header text.
wp-includes/theme.php: get_header_image()

Retrieves header image for custom header.
wp-includes/theme.php: is_random_header_image()

Checks if random header image is in use.
wp-includes/theme.php: get_custom_header()

Gets the header image data.
wp-includes/theme.php: get_background_image()

Retrieves background image for custom background.
wp-includes/class-wp-admin-bar.php: WP_Admin_Bar::initialize()
wp-includes/customize/class-wp-customize-header-image-setting.php: WP_Customize_Header_Image_Setting::update()
wp-includes/post-template.php: get_body_class()

Retrieves an array of the class names for the body element.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPostFormats()

Retrieves a list of post formats used by the site.
wp-includes/customize/class-wp-customize-header-image-control.php: WP_Customize_Header_Image_Control::enqueue()
wp-includes/customize/class-wp-customize-header-image-control.php: WP_Customize_Header_Image_Control::render_content()
Show 36 more used by Hide more used by

Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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] =>
        )

)

    Expand full source codeCollapse full source code

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