get_theme_support()

💡 云策文档标注

概述

get_theme_support() 函数用于获取主题支持功能的注册参数，是 WordPress 主题开发中检查 add_theme_support() 设置的核心工具。它支持多种功能参数，如 custom-logo、custom-header 等，并可返回具体参数值。

关键要点

函数用于检索主题支持功能的参数，基于 add_theme_support() 的注册信息。
参数 $feature 为必需，指定要检查的功能，如 'custom-logo'、'custom-header' 等，支持列表包括 admin-bar、align-wide 等核心值。
可选参数 $args 用于针对特定功能检查额外参数，例如 get_theme_support('custom-header', 'width') 可获取宽度值。
返回值类型为 mixed，可能返回参数数组、具体值或 false（如果功能未注册）。
内部实现基于全局变量 $_wp_theme_features，并针对 custom-logo、custom-header、custom-background 等特殊功能有特定处理逻辑。
函数在 WordPress 3.1.0 中引入，5.3.0 版本正式化 ...$args 参数签名。

代码示例

// 获取 custom-logo 支持参数
$theme_support = get_theme_support( 'custom-logo' );

// 获取 custom-header 的宽度参数
$width = get_theme_support( 'custom-header', 'width' );

// 获取 custom-background 支持参数示例
$theme_support = get_theme_support( 'custom-background' );
// 输出可能为包含 default-image、default-color 等键的数组

注意事项

使用前需确保主题已通过 add_theme_support() 注册相应功能，否则返回 false。
对于 custom-logo、custom-header、custom-background 等功能，可通过 $args 参数获取特定子参数值。
函数与多个核心功能相关，如 get_custom_logo()、is_header_video_active() 等，常用于主题定制和插件开发中。

📄 原文内容

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 by	Description
wp_enqueue_admin_bar_bump_styles()`wp-includes/admin-bar.php`	Enqueues inline bump styles to make room for the admin bar.
get_classic_theme_supports_block_editor_settings()`wp-includes/block-editor.php`	Returns the classic theme supports settings for block editor.
_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.
get_default_block_editor_settings()`wp-includes/block-editor.php`	Returns the default block editor settings.
wp_use_widgets_block_editor()`wp-includes/widgets.php`	Determines whether or not to use the block editor to manage widgets.
get_media_states()`wp-admin/includes/template.php`	Retrieves an array of media states from an attachment.
_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.
WP_Posts_List_Table::inline_edit()`wp-admin/includes/class-wp-posts-list-table.php`	Outputs the hidden row displayed when inline editing
Custom_Image_Header::get_header_dimensions()`wp-admin/includes/class-custom-image-header.php`	Calculates width and height based on what the currently selected theme supports.
Custom_Image_Header::get_default_header_images()`wp-admin/includes/class-custom-image-header.php`	Gets the details of default header images if defined.
Custom_Image_Header::step_1()`wp-admin/includes/class-custom-image-header.php`	Displays first step of custom header image page.
Custom_Image_Header::step_2()`wp-admin/includes/class-custom-image-header.php`	Displays second step of custom header image page.
Custom_Image_Header::reset_header_image()`wp-admin/includes/class-custom-image-header.php`	Resets a header image to the default image for the theme.
Custom_Image_Header::js_1()`wp-admin/includes/class-custom-image-header.php`	Displays JavaScript based on Step 1 and 3.
Custom_Image_Header::js_2()`wp-admin/includes/class-custom-image-header.php`	Displays JavaScript based on Step 2.
Custom_Background::admin_page()`wp-admin/includes/class-custom-background.php`	Displays the custom background page.
WP_Customize_Manager::register_controls()`wp-includes/class-wp-customize-manager.php`	Registers some default controls.
WP_Customize_Manager::_sanitize_header_textcolor()`wp-includes/class-wp-customize-manager.php`	Callback for validating the header_textcolor value.
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_Admin_Bar::initialize()`wp-includes/class-wp-admin-bar.php`	Initializes the admin bar.
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_xmlrpc_server::wp_getPostFormats()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves a list of post formats used by the site.
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 38 more Show less

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.

User Contributed Notes

Skip to note 2 content

Codex

10 years ago

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

)

云策 WordPress 开发者社区

函数文档

get_theme_support()

概述

关键要点

代码示例

注意事项

Description

Parameters

Return

Source

Changelog

User Contributed Notes

函数文档

概述

关键要点

代码示例

注意事项

Description

Parameters

Return

Source

Related

Changelog

User Contributed Notes