current_theme_supports() WordPress Function

The current_theme_supports() function is used to check if a particular theme feature is supported by the current theme. If the feature is supported, the function returns true. Otherwise, it returns false.

current_theme_supports( string $feature, mixed $args ) #

Checks a theme’s support for a given feature.

Contents

Description

Example usage:

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

Top ↑

Parameters

$feature

(string)(Required)The feature being checked. See add_theme_support() for the list of possible values.

$args

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

Top ↑

Return

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

Top ↑

Source

File: wp-includes/theme.php

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
}

Expand full source codeCollapse full source codeView on TracView on GitHub

Top ↑

Top ↑

Used By

Used By
Used ByDescription
wp-includes/block-editor.php:_wp_get_iframed_editor_assets()

Collect the block editor assets that need to be loaded into the editor’s iframe.

wp-includes/customize/class-wp-customize-nav-menus-panel.php:WP_Customize_Nav_Menus_Panel::check_capabilities()

Checks required user capabilities and whether the theme has the feature support required by the panel.

wp-includes/block-template.php:_add_template_loader_filters()

Adds necessary filters to use ‘wp_template’ posts instead of theme template files.

wp-includes/class-wp-theme-json-resolver.php:WP_Theme_JSON_Resolver::get_theme_data()

Returns the theme’s data.

wp-includes/theme-templates.php:the_block_template_skip_link()

Prints the skip-link script & styles.

wp-includes/block-editor.php:get_block_editor_theme_styles()

Creates an array of theme styles to load into the block editor.

wp-includes/block-template.php:locate_block_template()

Find a block template with equal or higher specificity than a given PHP template file.

wp-includes/script-loader.php:wp_get_inline_script_tag()

Wraps inline JavaScript in tag.

wp-includes/script-loader.php:wp_sanitize_script_attributes()

Sanitizes an attributes array into an attributes string to be placed inside a tag.

wp-includes/script-loader.php:wp_get_script_tag()

Formats loader tags.

wp-admin/includes/template.php:get_media_states()

Retrieves an array of media states from an attachment.

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/script-loader.php:wp_common_block_scripts_and_styles()

Handles the enqueueing of block scripts and styles that are common to both the editor and the front-end.

wp-admin/includes/meta-boxes.php:register_and_do_post_meta_boxes()

Registers the default post meta boxes, and runs the do_meta_boxes actions.

wp-includes/customize/class-wp-customize-nav-menu-locations-control.php:WP_Customize_Nav_Menu_Locations_Control::content_template()

JS/Underscore template for the control UI.

wp-includes/class-wp-theme.php:WP_Theme::get_post_templates()

Returns the theme’s post templates.

wp-includes/theme.php:wp_custom_css_cb()

Renders the Custom CSS style element.

wp-includes/theme.php:_custom_logo_header_styles()

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

wp-includes/class-wp-customize-widgets.php:WP_Customize_Widgets::customize_dynamic_partial_args()

Filters arguments for dynamic widget partials.

wp-includes/class-wp-customize-widgets.php:WP_Customize_Widgets::selective_refresh_init()

Adds hooks for selective refresh.

wp-includes/class-wp-customize-widgets.php:WP_Customize_Widgets::get_selective_refreshable_widgets()

List whether each registered widget can be use selective refresh.

wp-includes/embed.php:print_embed_styles()

Prints the CSS in the embed iframe header.

wp-includes/class-wp-customize-nav-menus.php:WP_Customize_Nav_Menus::customize_register()

Adds the customizer settings and controls.

wp-includes/class-wp-customize-nav-menus.php:WP_Customize_Nav_Menus::available_item_types()

Returns an array of all the available item types.

wp-includes/formatting.php:print_emoji_styles()

Prints the important emoji-related styles.

wp-includes/class-wp-customize-panel.php:WP_Customize_Panel::check_capabilities()

Checks required user capabilities and whether the theme has the feature support required by the panel.

wp-admin/includes/image.php:wp_generate_attachment_metadata()

Generate attachment meta data and create image sub-sizes for images.

wp-admin/includes/media.php:get_media_item()

Retrieves HTML form for modifying the image attachment.

wp-admin/includes/post.php:get_default_post_to_edit()

Returns default post information to use when populating the “Write Post” form.

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

Displays 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::ajax_header_crop()

Gets attachment uploaded by Media Manager, crops it, then saves it as a new object. Returns JSON-encoded object details.

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::step_3()

Display third step of custom header image page.

wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::js_includes()

Set up the enqueue for the JavaScript files.

wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::css_includes()

Set up the enqueue for the CSS files

wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::js()

Execute JavaScript depending on step.

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()

Registers some default controls.

wp-includes/class.wp-styles.php:WP_Styles::__construct()

Constructor.

wp-includes/theme.php:wp_customize_support_script()

Prints a script to check whether or not the Customizer is supported, and apply either the no-customize-support or customize-support class to the body.

wp-includes/theme.php:_custom_background_cb()

Default custom background callback.

wp-includes/theme.php:remove_editor_styles()

Removes all visual editor stylesheets.

wp-includes/theme.php:_custom_header_background_just_in_time()

Registers the internal custom header and background routines.

wp-includes/theme.php:current_theme_supports()

Checks a theme’s support for a given feature.

wp-includes/theme.php:require_if_theme_supports()

Checks a theme’s support for a given feature before loading the functions which implement it.

wp-includes/theme.php:display_header_text()

Whether to display the header text.

wp-includes/theme.php:_get_random_header_data()

Gets random header image data from registered images in theme.

wp-includes/theme.php:get_custom_header()

Gets the header image data.

wp-includes/theme.php:locale_stylesheet()

Displays localized stylesheet link element.

wp-includes/general-template.php:feed_links()

Display the links to the general feeds.

wp-includes/general-template.php:get_search_form()

Display search form.

wp-includes/functions.php:wp_widgets_add_menu()

Append the Widgets menu to the themes main menu.

wp-includes/widgets/class-wp-nav-menu-widget.php:WP_Nav_Menu_Widget::widget()

Outputs the content for the current Navigation Menu widget instance.

wp-includes/widgets/class-wp-widget-tag-cloud.php:WP_Widget_Tag_Cloud::widget()

Outputs the content for the current Tag Cloud widget instance.

wp-includes/widgets/class-wp-widget-rss.php:WP_Widget_RSS::widget()

Outputs the content for the current RSS widget instance.

wp-includes/widgets/class-wp-widget-recent-comments.php:WP_Widget_Recent_Comments::recent_comments_style()

Outputs the default styles for the Recent Comments widget.

wp-includes/widgets/class-wp-widget-recent-comments.php:WP_Widget_Recent_Comments::widget()

Outputs the content for the current Recent Comments widget instance.

wp-includes/widgets/class-wp-widget-recent-posts.php:WP_Widget_Recent_Posts::widget()

Outputs the content for the current Recent Posts widget instance.

wp-includes/widgets/class-wp-widget-categories.php:WP_Widget_Categories::widget()

Outputs the content for the current Categories widget instance.

wp-includes/widgets/class-wp-widget-meta.php:WP_Widget_Meta::widget()

Outputs the content for the current Meta widget instance.

wp-includes/widgets/class-wp-widget-archives.php:WP_Widget_Archives::widget()

Outputs the content for the current Archives widget instance.

wp-includes/widgets/class-wp-widget-pages.php:WP_Widget_Pages::widget()

Outputs the content for the current Pages widget instance.

wp-includes/class-wp-customize-section.php:WP_Customize_Section::check_capabilities()

Checks required user capabilities and whether the theme has the feature support required by the section.

wp-includes/taxonomy.php:create_initial_taxonomies()

Creates the initial taxonomies.

wp-includes/class-wp-admin-bar.php:WP_Admin_Bar::initialize()

Initializes the admin bar.

wp-includes/admin-bar.php:wp_admin_bar_appearance_menu()

Adds appearance submenu items to the “Site Name” menu.

wp-includes/admin-bar.php:wp_admin_bar_header()

Prints style and scripts for the admin bar.

wp-includes/admin-bar.php:_admin_bar_bump_cb()

Prints default admin bar callback.

wp-includes/class-wp-customize-setting.php:WP_Customize_Setting::check_capabilities()

Validate user capabilities whether the theme supports the setting.

wp-includes/post-template.php:get_post_class()

Retrieves an array of the class names for the post container element.

wp-includes/post-template.php:get_body_class()

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

wp-includes/media.php:wp_enqueue_media()

Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.

wp-includes/media.php:gallery_shortcode()

Builds the Gallery shortcode output.

wp-includes/media.php:img_caption_shortcode()

Builds the Caption shortcode output.

wp-includes/post.php:wp_insert_post()

Insert or update a post.

wp-includes/class.wp-scripts.php:WP_Scripts::init()

Initialize the class.

wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::wp_getPostFormats()

Retrieves a list of post formats used by the site.

wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::_prepare_post()

Prepares post data for return in an XML-RPC object.

wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::initialise_blog_option_info()

Set up blog options property.

wp-includes/customize/class-wp-customize-header-image-control.php:WP_Customize_Header_Image_Control::render_content()
wp-includes/comment-template.php:wp_list_comments()

Displays a list of comments.

wp-includes/comment-template.php:comment_form()

Outputs a complete commenting form for use within a template.

wp-includes/class-wp-customize-widgets.php:WP_Customize_Widgets::get_setting_args()

Retrieves common arguments to supply when constructing a Customizer setting.

Show 83 more used byHide more used by

Top ↑

Changelog

Changelog
VersionDescription
5.3.0Formalized the existing and already documented ...$args parameter by adding it to the function signature.
2.9.0Introduced.
Download the latest version of WordPress from https://wordpress.org/

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More