wp_get_ability() │ WP 6.9.0

Получает объект зарегистрированной возможности из Abilities API.

Объект WP_Ability{} содержит настройки, метаданные и методы выполнения возможности.

Если возможность не зарегистрирована, WordPress вызовет предупреждение _doing_it_wrong(). Проверить её наличие можно через wp_has_ability().

Работает на основе: WP_Abilities_Registry::get_instance(), WP_Abilities_Registry::get_registered()

Хуков нет.

Возвращает

WP_Ability|null.

WP_Ability - объект зарегистрированной возможности.
null - если возможность не зарегистрирована или реестр недоступен.

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

wp_get_ability( $name ): ?WP_Ability;

$name(string) (обязательный): Название возможности с пространством имён. Например, my-plugin/my-ability.

Примеры

#1 Получение информации о возможности

if ( wp_has_ability( 'my-plugin/export-data' ) ) {
	$ability = wp_get_ability( 'my-plugin/export-data' );

	echo esc_html(
		$ability->get_label() . ': ' . $ability->get_description()
	);
}

Заметки

Смотрите: WP_Abilities_Registry::get_registered()
Смотрите: wp_has_ability()

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

С версии 6.9.0

Введена.

Код `wp_get_ability() wp get ability` ^{WP 7.0.2}

wp-includes/abilities-api.php

function wp_get_ability( string $name ): ?WP_Ability {
	$registry = WP_Abilities_Registry::get_instance();
	if ( null === $registry ) {
		return null;
	}

	return $registry->get_registered( $name );
}