get_theme_support() WordPress Function

The get_theme_support() function is used to retrieve the current theme's support settings. These settings can be used to add or remove theme support for various features.

get_theme_support( string $feature, mixed $args ) #

Gets the theme support arguments passed when registering that support.


Description

Example usage:

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

Top ↑

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

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


Top ↑

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


Top ↑

Changelog

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

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