wordpress-seo / src / abilities / domain / ability-interface.php

ability-interface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI trunk, at src/abilities/domain/ability-interface.php

35 lines 961 B

Raw Download Zip

1	<?php
2
3	namespace Yoast\WP\SEO\Abilities\Domain;
4
5	/**
6	* Describes an ability that can be registered with the WordPress Abilities API.
7	*/
8	interface Ability_Interface {
9
10	/**
11	* Returns the full name of the ability, including the category prefix.
12	*
13	* @return string The ability name, e.g. `yoast-seo/get-seo-scores`.
14	*/
15	public function get_name(): string;
16
17	// phpcs:disable SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint -- The registration arguments are heterogeneous by nature.
18
19	/**
20	* Returns the arguments to register the ability with.
21	*
22	* @return array<string, mixed> The ability registration arguments.
23	*/
24	public function get_args(): array;
25
26	// phpcs:enable SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint
27
28	/**
29	* Returns whether the ability should be registered at all.
30	*
31	* @return bool Whether the ability is available.
32	*/
33	public function is_available(): bool;
34	}
35