current_theme_supports()

💡 云策文档标注

概述

current_theme_supports() 函数用于检查当前激活主题是否支持特定功能。它基于 add_theme_support() 注册的功能列表进行验证，并返回布尔值。

关键要点

函数接受一个必需参数 $feature（字符串），指定要检查的功能，如 'custom-logo' 或 'html5'。
可选参数 $args（混合类型）用于针对某些功能进行额外检查，例如 'post-thumbnails' 的内容类型。
返回值为布尔值：true 表示主题支持该功能，false 表示不支持。
函数内部处理了特定功能（如 'custom-header-uploads'、'post-thumbnails'、'html5'、'post-formats'、'custom-logo'、'custom-header'、'custom-background'）的特殊逻辑。
通过 apply_filters( "current_theme_supports-{$feature}" ) 钩子允许动态过滤支持状态。

代码示例

current_theme_supports( 'custom-logo' );
current_theme_supports( 'html5', 'comment-form' );

注意事项

功能列表参考 add_theme_support()，包括 'admin-bar'、'align-wide'、'custom-logo' 等核心值。
在 WordPress 5.3.0 中正式引入了 ...$args 参数，2.9.0 版本首次引入此函数。
使用时需确保主题已通过 add_theme_support() 正确注册功能，否则可能返回 false。

📄 原文内容

Checks a theme’s support for a given feature.

Description

Example usage:

current_theme_supports( 'custom-logo' );
current_theme_supports( 'html5', 'comment-form' );

Parameters

$featurestringrequired

The feature being checked. 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

bool True if the active theme supports the feature, false otherwise.

Source

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

	if ( 'custom-header-uploads' === $feature ) {
		return current_theme_supports( 'custom-header', 'uploads' );
	}

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

	// If no args passed then no extra checks need to be performed.
	if ( ! $args ) {
		/** This filter is documented in wp-includes/theme.php */
		return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[ $feature ] ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
	}

	switch ( $feature ) {
		case 'post-thumbnails':
			/*
			 * post-thumbnails can be registered for only certain content/post types
			 * by passing an array of types to add_theme_support().
			 * If no array was passed, then any type is accepted.
			 */
			if ( true === $_wp_theme_features[ $feature ] ) {  // Registered for all types.
				return true;
			}
			$content_type = $args[0];
			return in_array( $content_type, $_wp_theme_features[ $feature ][0], true );

		case 'html5':
		case 'post-formats':
			/*
			 * Specific post formats can be registered by passing an array of types
			 * to add_theme_support().
			 *
			 * Specific areas of HTML5 support *must* be passed via an array to add_theme_support().
			 */
			$type = $args[0];
			return in_array( $type, $_wp_theme_features[ $feature ][0], true );

		case 'custom-logo':
		case 'custom-header':
		case 'custom-background':
			// Specific capabilities can be registered by passing an array to add_theme_support().
			return ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) && $_wp_theme_features[ $feature ][0][ $args[0] ] );
	}

	/**
	 * Filters whether the active theme supports a specific feature.
	 *
	 * The dynamic portion of the hook name, `$feature`, refers to the specific
	 * theme feature. See add_theme_support() for the list of possible values.
	 *
	 * @since 3.4.0
	 *
	 * @param bool   $supports Whether the active theme supports the given feature. Default true.
	 * @param array  $args     Array of arguments for the feature.
	 * @param string $feature  The theme feature.
	 */
	return apply_filters( "current_theme_supports-{$feature}", true, $args, $_wp_theme_features[ $feature ] ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
}

View all references View on Trac View on GitHub

Hooks

apply_filters( “current_theme_supports-{$feature}”, bool $supports, array $args, string $feature ): Filters whether the active theme supports a specific feature.

Uses	Description
current_theme_supports()`wp-includes/theme.php`	Checks a theme’s support for a given feature.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Used by	Description
_wp_render_title_tag()`wp-includes/general-template.php`	Displays title tag with content.
WP_REST_Attachments_Controller::handle_featured_media()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Determines the featured media based on a request param.
wp_enqueue_admin_bar_bump_styles()`wp-includes/admin-bar.php`	Enqueues inline bump styles to make room for the admin bar.
WP_Font_Face::__construct()`wp-includes/fonts/class-wp-font-face.php`	Creates and initializes an instance of WP_Font_Face.
wp_enqueue_block_template_skip_link()`wp-includes/theme-templates.php`	Enqueues the skip-link script & styles.
WP_Theme_JSON::get_layout_styles()`wp-includes/class-wp-theme-json.php`	Gets the CSS layout rules for a particular block from theme.json layout definitions.
_wp_get_iframed_editor_assets()`wp-includes/block-editor.php`	Collect the block editor assets that need to be loaded into the editor’s iframe.
wp_get_global_stylesheet()`wp-includes/global-styles-and-settings.php`	Returns the stylesheet resulting of merging core, theme, and user data.
_add_default_theme_supports()`wp-includes/theme.php`	Adds default theme supports for block themes when the ‘after_setup_theme’ action fires.
_add_template_loader_filters()`wp-includes/block-template.php`	Adds necessary hooks to resolve ‘_wp-find-template’ requests.
WP_Theme_JSON_Resolver::get_theme_data()`wp-includes/class-wp-theme-json-resolver.php`	Returns the theme’s data.
the_block_template_skip_link()`wp-includes/deprecated.php`	Prints the skip-link script & styles.
get_block_editor_settings()`wp-includes/block-editor.php`	Returns the contextualized block editor settings for a selected editor context.
get_block_editor_theme_styles()`wp-includes/block-editor.php`	Creates an array of theme styles to load into the block editor.
locate_block_template()`wp-includes/block-template.php`	Finds a block template with equal or higher specificity than a given PHP template file.
wp_get_inline_script_tag()`wp-includes/script-loader.php`	Constructs an inline script tag.
wp_sanitize_script_attributes()`wp-includes/script-loader.php`	Sanitizes an attributes array into an attributes string to be placed inside a tag.
wp_get_script_tag()`wp-includes/script-loader.php`	Formats loader tags.
get_media_states()`wp-admin/includes/template.php`	Retrieves an array of media states from an attachment.
register_block_type_from_metadata()`wp-includes/blocks.php`	Registers a block type from the metadata stored in the `block.json` file.
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.
wp_common_block_scripts_and_styles()`wp-includes/script-loader.php`	Handles the enqueueing of block scripts and styles that are common to both the editor and the front-end.
register_and_do_post_meta_boxes()`wp-admin/includes/meta-boxes.php`	Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
WP_Customize_Nav_Menu_Locations_Control::content_template()`wp-includes/customize/class-wp-customize-nav-menu-locations-control.php`	JS/Underscore template for the control UI.
WP_Theme::get_post_templates()`wp-includes/class-wp-theme.php`	Returns the theme’s post templates.
wp_custom_css_cb()`wp-includes/theme.php`	Renders the Custom CSS style element.
_custom_logo_header_styles()`wp-includes/theme.php`	Adds CSS to hide header text for custom logo, based on Customizer setting.
WP_Customize_Widgets::customize_dynamic_partial_args()`wp-includes/class-wp-customize-widgets.php`	Filters arguments for dynamic widget partials.
WP_Customize_Widgets::selective_refresh_init()`wp-includes/class-wp-customize-widgets.php`	Adds hooks for selective refresh.
WP_Customize_Widgets::get_selective_refreshable_widgets()`wp-includes/class-wp-customize-widgets.php`	List whether each registered widget can be use selective refresh.
print_embed_styles()`wp-includes/deprecated.php`	Prints the CSS in the embed iframe header.
WP_Customize_Nav_Menus::customize_register()`wp-includes/class-wp-customize-nav-menus.php`	Adds the customizer settings and controls.
WP_Customize_Nav_Menus::available_item_types()`wp-includes/class-wp-customize-nav-menus.php`	Returns an array of all the available item types.
print_emoji_styles()`wp-includes/deprecated.php`	Prints the important emoji-related styles.
WP_Customize_Panel::check_capabilities()`wp-includes/class-wp-customize-panel.php`	Checks required user capabilities and whether the theme has the feature support required by the panel.
wp_generate_attachment_metadata()`wp-admin/includes/image.php`	Generates attachment meta data and create image sub-sizes for images.
get_media_item()`wp-admin/includes/media.php`	Retrieves HTML form for modifying the image attachment.
get_default_post_to_edit()`wp-admin/includes/post.php`	Returns default post information to use when populating the “Write Post” form.
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::ajax_header_crop()`wp-admin/includes/class-custom-image-header.php`	Gets attachment uploaded by Media Manager, crops it, then saves it as a new object. Returns JSON-encoded object details.
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::step_3()`wp-admin/includes/class-custom-image-header.php`	Displays third step of custom header image page.
Custom_Image_Header::js_includes()`wp-admin/includes/class-custom-image-header.php`	Sets up the enqueue for the JavaScript files.
Custom_Image_Header::css_includes()`wp-admin/includes/class-custom-image-header.php`	Sets up the enqueue for the CSS files.
Custom_Image_Header::js()`wp-admin/includes/class-custom-image-header.php`	Executes JavaScript depending on step.
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_Styles::__construct()`wp-includes/class-wp-styles.php`	Constructor.
_custom_background_cb()`wp-includes/theme.php`	Default custom background callback.
remove_editor_styles()`wp-includes/theme.php`	Removes all visual editor stylesheets.
_custom_header_background_just_in_time()`wp-includes/theme.php`	Registers the internal custom header and background routines.
current_theme_supports()`wp-includes/theme.php`	Checks a theme’s support for a given feature.
require_if_theme_supports()`wp-includes/theme.php`	Checks a theme’s support for a given feature before loading the functions which implement it.
display_header_text()`wp-includes/theme.php`	Whether to display the header text.
_get_random_header_data()`wp-includes/theme.php`	Gets random header image data from registered images in theme.
get_custom_header()`wp-includes/theme.php`	Gets the header image data.
locale_stylesheet()`wp-includes/theme.php`	Displays localized stylesheet link element.
feed_links()`wp-includes/general-template.php`	Displays the links to the general feeds.
get_search_form()`wp-includes/general-template.php`	Displays search form.
wp_widgets_add_menu()`wp-includes/functions.php`	Appends the Widgets menu to the themes main menu.
WP_Nav_Menu_Widget::widget()`wp-includes/widgets/class-wp-nav-menu-widget.php`	Outputs the content for the current Navigation Menu widget instance.
WP_Widget_Tag_Cloud::widget()`wp-includes/widgets/class-wp-widget-tag-cloud.php`	Outputs the content for the current Tag Cloud widget instance.
WP_Widget_RSS::widget()`wp-includes/widgets/class-wp-widget-rss.php`	Outputs the content for the current RSS widget instance.
WP_Widget_Recent_Posts::widget()`wp-includes/widgets/class-wp-widget-recent-posts.php`	Outputs the content for the current Recent Posts widget instance.
WP_Widget_Recent_Comments::recent_comments_style()`wp-includes/widgets/class-wp-widget-recent-comments.php`	Outputs the default styles for the Recent Comments widget.
WP_Widget_Recent_Comments::widget()`wp-includes/widgets/class-wp-widget-recent-comments.php`	Outputs the content for the current Recent Comments widget instance.
WP_Widget_Categories::widget()`wp-includes/widgets/class-wp-widget-categories.php`	Outputs the content for the current Categories widget instance.
WP_Widget_Archives::widget()`wp-includes/widgets/class-wp-widget-archives.php`	Outputs the content for the current Archives widget instance.
WP_Widget_Meta::widget()`wp-includes/widgets/class-wp-widget-meta.php`	Outputs the content for the current Meta widget instance.
WP_Widget_Pages::widget()`wp-includes/widgets/class-wp-widget-pages.php`	Outputs the content for the current Pages widget instance.
WP_Customize_Section::check_capabilities()`wp-includes/class-wp-customize-section.php`	Checks required user capabilities and whether the theme has the feature support required by the section.
create_initial_taxonomies()`wp-includes/taxonomy.php`	Creates the initial taxonomies.
WP_Admin_Bar::initialize()`wp-includes/class-wp-admin-bar.php`	Initializes the admin bar.
wp_admin_bar_appearance_menu()`wp-includes/admin-bar.php`	Adds appearance submenu items to the “Site Name” menu.
wp_admin_bar_header()`wp-includes/deprecated.php`	Prints style and scripts for the admin bar.
_admin_bar_bump_cb()`wp-includes/deprecated.php`	Prints default admin bar callback.
WP_Customize_Setting::check_capabilities()`wp-includes/class-wp-customize-setting.php`	Validate user capabilities whether the theme supports the setting.
get_body_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the body element.
get_post_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the post container element.
wp_enqueue_media()`wp-includes/media.php`	Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.
gallery_shortcode()`wp-includes/media.php`	Builds the Gallery shortcode output.
img_caption_shortcode()`wp-includes/media.php`	Builds the Caption shortcode output.
wp_insert_post()`wp-includes/post.php`	Inserts or update a post.
wp_xmlrpc_server::wp_getPostFormats()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves a list of post formats used by the site.
wp_xmlrpc_server::_prepare_post()`wp-includes/class-wp-xmlrpc-server.php`	Prepares post data for return in an XML-RPC object.
wp_xmlrpc_server::initialise_blog_option_info()`wp-includes/class-wp-xmlrpc-server.php`	Sets up blog options property.
WP_Customize_Header_Image_Control::render_content()`wp-includes/customize/class-wp-customize-header-image-control.php`
wp_list_comments()`wp-includes/comment-template.php`	Displays a list of comments.
comment_form()`wp-includes/comment-template.php`	Outputs a complete commenting form for use within a template.
WP_Customize_Widgets::get_setting_args()`wp-includes/class-wp-customize-widgets.php`	Retrieves common arguments to supply when constructing a Customizer setting.
wp_default_styles()`wp-includes/script-loader.php`	Assigns default styles to $styles object.

Show 91 more Show less

Changelog

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

User Contributed Notes

Skip to note 2 content

Codex

10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Basic Example
Log in to add feedback

云策 WordPress 开发者社区

函数文档