Yoast\WP\SEO\Llms_Txt\User_Interface

Available_Posts_Route{} │ Yoast 1.0└─ Route_Interface

Available posts route.

Хуков нет.

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

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

Методы

1. public __construct(
2. public get_available_posts( WP_REST_Request $request )
3. public permission_manage_options()
4. public register_routes()
5. public validate_request_parameters( Parameters $request_parameters )

Код Available_Posts_Route{} Available Posts Route{} ^{Yoast 27.7}

class Available_Posts_Route implements Route_Interface {

	use No_Conditionals;

	/**
	 * The namespace of the route.
	 *
	 * @var string
	 */
	public const ROUTE_NAMESPACE = Main::API_V1_NAMESPACE;

	/**
	 * The prefix of the route.
	 *
	 * @var string
	 */
	public const ROUTE_NAME = '/available_posts';

	/**
	 * Holds the available posts repository.
	 *
	 * @var Available_Posts_Repository
	 */
	private $available_posts_repository;

	/**
	 * Holds the capability helper instance.
	 *
	 * @var Capability_Helper
	 */
	private $capability_helper;

	/**
	 * The constructor.
	 *
	 * @param Available_Posts_Repository $available_posts_repository The data provider for the available posts.
	 * @param Capability_Helper          $capability_helper          The capability helper.
	 */
	public function __construct(
		Available_Posts_Repository $available_posts_repository,
		Capability_Helper $capability_helper
	) {
		$this->available_posts_repository = $available_posts_repository;
		$this->capability_helper          = $capability_helper;
	}

	/**
	 * Registers routes for scores.
	 *
	 * @return void
	 */
	public function register_routes() {
		\register_rest_route(
			self::ROUTE_NAMESPACE,
			self::ROUTE_NAME,
			[
				[
					'methods'             => 'GET',
					'callback'            => [ $this, 'get_available_posts' ],
					'permission_callback' => [ $this, 'permission_manage_options' ],
					'args'                => [
						'search'   => [
							'type'              => 'string',
							'sanitize_callback' => 'sanitize_text_field',
							'default'           => '',
						],
						'postType' => [
							'type'              => 'string',
							'sanitize_callback' => 'sanitize_text_field',
							'default'           => 'page',
						],
					],
				],
			],
		);
	}

	/**
	 * Gets the available posts.
	 *
	 * @param WP_REST_Request $request The request object.
	 *
	 * @return WP_REST_Response The success or failure response.
	 */
	public function get_available_posts( WP_REST_Request $request ): WP_REST_Response {
		try {
			$request_parameters = new Parameters( $request->get_param( 'postType' ), $request->get_param( 'search' ) );
			$this->validate_request_parameters( $request_parameters );

			$available_posts_container = $this->available_posts_repository->get_posts( $request_parameters );
		} catch ( Exception $exception ) {
			return new WP_REST_Response(
				[
					'error' => $exception->getMessage(),
				],
				$exception->getCode(),
			);
		}

		return new WP_REST_Response(
			$available_posts_container->to_array(),
			200,
		);
	}

	/**
	 * Validates the request's parameters.
	 *
	 * @param Parameters $request_parameters The request parameters.
	 *
	 * @return void.
	 *
	 * @throws Invalid_Post_Type_Exception When the given post type is invalid.
	 */
	public function validate_request_parameters( Parameters $request_parameters ): void {
		if ( ! \is_a( \get_post_type_object( $request_parameters->get_post_type() ), WP_Post_Type::class ) ) {
			throw new Invalid_Post_Type_Exception();
		}
	}

	/**
	 * Permission callback.
	 *
	 * @return bool True when user has the 'wpseo_manage_options' capability.
	 */
	public function permission_manage_options() {
		return $this->capability_helper->current_user_can( 'wpseo_manage_options' );
	}
}