get_theme_support( string $feature, mixed $args )

Gets the theme support arguments passed when registering that support


Description Description

Example usage:

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

Parameters Parameters

$feature

(string) (Required) The feature to check.

$args

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


Top ↑

Return Return

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


Top ↑

Source 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

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.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

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

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