current_theme_supports() │ WP 2.9.0

Проверяет, поддерживает ли тема указанную возможность, зарегистрированную через add_theme_support().

Для возможностей, принимающих аргументы (например, 'html5' или 'custom-logo'), можно передать дополнительные значения, чтобы убедиться, что поддерживаются именно они.

Нужно вызывать после того, как поддержка темы объявлена, обычно после хука after_setup_theme.

Используйте фильтр current_theme_supports-(feature), когда нужно отключить или включить поддержку в опредленных условиях.

1 раз — 0.000013 сек (очень быстро) | 50000 раз — 0.01 сек (скорость света) | PHP 7.0.8, WP 4.6.1
Хуки из функции

Возвращает

true|false. true, если тема поддерживает указанную возможность, иначе false.

Использование

if( current_theme_supports( $feature ) ){
	 // возможность $feature включена...
}
$feature(строка) (обязательный)

Имя возможности, которую нужно проверить. Список доступных:

...$args(mixed)

Дополнительные аргументы для конкретной возможности, которые также нужно проверить.

Когда тема объявляет поддержку опции с подпунктами, она передаёт массив этих подпунктов:

add_theme_support( 'html5', [ 'comment-form', 'comment-list' ] );

Функция ведёт себя так:

  • Без аргументов - достаточно самого факта, что возможность html5 поддерживается:

    current_theme_supports( 'html5' ); // true

  • С аргументами - функция проверяет каждый переданный подпункт. Если хотя бы один не поддерживается, вернёт false. true получится только когда все указанные подпункты поддерживаются.

    current_theme_supports( 'html5', 'comment-form' );   // true
current_theme_supports( 'html5', 'search-form' );    // false
current_theme_supports( 'html5', 'comment-form', 'search-form' ); // false

По умолчанию: отсутствуют

Примеры

0

#1 Демо

Проверим включена ли возможность:

if( current_theme_supports('custom-header') ){
	 // Сделаем что-нибудь особенное, если возможность custom-header включена...
}

Проверка конкретного аргумента HTML5-поддержки:

if ( current_theme_supports( 'html5', 'comment-form' ) ) {
	// Загружаем стили или выполняем логику, требующую HTML5-разметку формы комментариев
}

Заметки

  • Global. Массив. $_wp_theme_features

Список изменений

С версии 2.9.0 Введена.
С версии 5.3.0 Formalized the existing and already documented ...$args parameter by adding it to the function signature.

Код current_theme_supports() WP 7.0

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
}

theme_support

Другие функции темы