Yoast\WP\SEO\Abilities\User_Interface\Abilities

Abstract_Set_Feature_Status_Ability{} │ abstract │ Yoast 1.0└─ Ability_Interface

Base class for the abilities that enable or disable a feature.

Features toggled by writing a boolean option and nothing else extend Abstract_Set_Option_Status_Ability. Features whose toggle has side effects worth reporting extend this class directly and bring their own updater.

Хуков нет.

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

$Abstract_Set_Feature_Status_Ability = new Abstract_Set_Feature_Status_Ability();
// use class methods

Методы

1. public __construct( Capability_Helper $capability_helper )
2. public can_manage_seo()
3. public execute( array $input )
4. public get_args()
5. public get_description()
6. public get_feature_name()
7. public get_label()
8. public get_name()
9. public get_slug()
10. public is_available()
11. protected get_additional_output_properties()

Код Abstract_Set_Feature_Status_Ability{} Abstract Set Feature Status Ability{} ^{Yoast 28.8}

abstract class Abstract_Set_Feature_Status_Ability implements Ability_Interface {

	/**
	 * The capability helper.
	 *
	 * @var Capability_Helper
	 */
	private $capability_helper;

	/**
	 * Constructor.
	 *
	 * @param Capability_Helper $capability_helper The capability helper.
	 */
	public function __construct( Capability_Helper $capability_helper ) {
		$this->capability_helper = $capability_helper;
	}

	/**
	 * Enables or disables the feature and returns its new status.
	 *
	 * @param array<string, bool> $input The input holding the desired `enabled` status.
	 *
	 * @return array<string, bool|string>|WP_Error The new status, or an error when it could not be saved.
	 */
	abstract public function execute( array $input );

	/**
	 * Returns the part of the ability name that follows the category slug.
	 *
	 * @return string The ability slug.
	 */
	abstract protected function get_slug(): string;

	/**
	 * Returns the human-readable name of the feature, used in the schema descriptions.
	 *
	 * @return string The feature name.
	 */
	abstract protected function get_feature_name(): string;

	/**
	 * Returns the label of the ability.
	 *
	 * @return string The label.
	 */
	abstract protected function get_label(): string;

	/**
	 * Returns the description of the ability.
	 *
	 * @return string The description.
	 */
	abstract protected function get_description(): string;

	/**
	 * Returns the full name of the ability.
	 *
	 * @return string The ability name.
	 */
	public function get_name(): string {
		return Ability_Categories_Integration::CATEGORY_SLUG . '/' . $this->get_slug();
	}

	/**
	 * Returns whether the ability is available. Features that cannot be enabled in every
	 * environment override this.
	 *
	 * @return bool Whether the ability is available.
	 */
	public function is_available(): bool {
		return true;
	}

	/**
	 * Checks whether the current user can manage Yoast SEO.
	 *
	 * Gates the ability behind the same capability that gates the settings page where the
	 * feature is toggled.
	 *
	 * @return bool Whether the current user can manage Yoast SEO.
	 */
	public function can_manage_seo(): bool {
		return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
	}

	// phpcs:disable SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint -- The JSON schema arrays are heterogeneous by nature.

	/**
	 * Returns the output schema properties a feature adds next to `enabled`. Features whose
	 * toggle has side effects worth reporting override this.
	 *
	 * @return array<string, array<string, mixed>> The additional output schema properties.
	 */
	protected function get_additional_output_properties(): array {
		return [];
	}

	/**
	 * Returns the arguments to register the ability with.
	 *
	 * @return array<string, mixed> The ability registration arguments.
	 */
	public function get_args(): array {
		$feature_name = $this->get_feature_name();

		return [
			'label'               => $this->get_label(),
			'description'         => $this->get_description(),
			'category'            => Ability_Categories_Integration::CATEGORY_SLUG,
			'input_schema'        => [
				'type'                 => 'object',
				'additionalProperties' => false,
				'required'             => [ 'enabled' ],
				'properties'           => [
					'enabled' => [
						'type'        => 'boolean',
						'description' => \sprintf(
							/* translators: %1$s expands to Yoast SEO, %2$s: the name of the feature. */
							\__( 'Whether %1$s\'s %2$s feature should be enabled. true enables it; false disables it.', 'wordpress-seo' ),
							'Yoast SEO',
							$feature_name,
						),
					],
				],
			],
			'output_schema'       => [
				'type'       => 'object',
				'properties' => \array_merge(
					[
						'enabled' => [
							'type'        => 'boolean',
							'description' => \sprintf(
								/* translators: %1$s expands to Yoast SEO, %2$s: the name of the feature. */
								\__( 'Whether %1$s\'s %2$s feature is enabled.', 'wordpress-seo' ),
								'Yoast SEO',
								$feature_name,
							),
						],
					],
					$this->get_additional_output_properties(),
				),
			],
			'permission_callback' => [ $this, 'can_manage_seo' ],
			'execute_callback'    => [ $this, 'execute' ],
			'meta'                => [
				'show_in_rest' => true,
				'annotations'  => [
					'readonly'    => false,
					'destructive' => null,
					'idempotent'  => true,
				],
				'mcp'          => [
					'public' => true,
				],
			],
		];
	}

	// phpcs:enable SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint
}