current_theme_supports( string $feature, mixed $args )

Checks a theme’s support for a given feature.

Contents

Description Description

Example usage:

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

Parameters Parameters

$feature

(string) (Required) The feature being checked.

$args

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

Top ↑

Return Return

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

Top ↑

Source 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 be performed
	if ( ! $args ) {
		return true;
	}

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

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

		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 current theme supports a specific feature.
	 *
	 * The dynamic portion of the hook name, `$feature`, refers to the specific theme
	 * feature. Possible values include 'post-formats', 'post-thumbnails', 'custom-background',
	 * 'custom-header', 'menus', 'automatic-feed-links', 'html5',
	 * 'starter-content', and 'customize-selective-refresh-widgets'.
	 *
	 * @since 3.4.0
	 *
	 * @param bool   true     Whether the current 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 code Collapse full source code View on Trac

Top ↑

Changelog Changelog

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.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
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/theme.php: wp_custom_css_cb()

Render 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/embed.php: print_embed_scripts()

Prints the JavaScript in the embed iframe header.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::customize_register()

Add the customizer settings and controls.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::available_item_types()

Return an array of all the available item types.
wp-includes/formatting.php: print_emoji_styles()

Print 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/dashboard.php: wp_welcome_panel()

Displays a welcome panel to introduce users to WordPress.
wp-admin/includes/template.php: _media_states()

Function to echo the attachment media states as HTML.
wp-admin/includes/media.php: get_media_item()

Retrieve HTML form for modifying the image attachment.
wp-admin/includes/post.php: get_default_post_to_edit()

Default post information to use when populating the “Write Post” form.
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::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()

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

Get random header image data from registered images in theme.
wp-includes/theme.php: get_custom_header()

Get the header image data.
wp-includes/theme.php: locale_stylesheet()

Display 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-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-categories.php: WP_Widget_Categories::widget()

Outputs the content for the current Categories 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/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()
wp-includes/admin-bar.php: wp_admin_bar_appearance_menu()

Add appearance submenu items to the “Site Name” menu.
wp-includes/admin-bar.php: wp_admin_bar_header()

Style and scripts for the admin bar.
wp-includes/admin-bar.php: _admin_bar_bump_cb()

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

Retrieves an array of the class names for the body element.
wp-includes/post-template.php: get_post_class()

Retrieves an array of the class names for the post container 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()

List 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 66 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

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