R E D

NAME	SIZE	PERMISSION
class-wp-rest-abilities-v1-categories-controller.php	7.9 KB	-rwxr-xr-x
class-wp-rest-abilities-v1-list-controller.php	10.24 KB	-rwxr-xr-x
class-wp-rest-abilities-v1-run-controller.php	6.87 KB	-rwxr-xr-x
class-wp-rest-application-passwords-controller.php	23.75 KB	-rwxr-xr-x
class-wp-rest-attachments-controller.php	52.96 KB	-rwxr-xr-x
class-wp-rest-autosaves-controller.php	14.88 KB	-rwxr-xr-x
class-wp-rest-block-directory-controller.php	9.71 KB	-rwxr-xr-x
class-wp-rest-block-pattern-categories-controller.php	4.7 KB	-rwxr-xr-x
class-wp-rest-block-patterns-controller.php	9.08 KB	-rwxr-xr-x
class-wp-rest-block-renderer-controller.php	5.7 KB	-rwxr-xr-x
class-wp-rest-block-types-controller.php	26.25 KB	-rwxr-xr-x
class-wp-rest-blocks-controller.php	3.1 KB	-rwxr-xr-x
class-wp-rest-comments-controller.php	61.24 KB	-rwxr-xr-x
class-wp-rest-controller.php	18.62 KB	-rwxr-xr-x
class-wp-rest-edit-site-export-controller.php	2.06 KB	-rwxr-xr-x
class-wp-rest-font-collections-controller.php	10.47 KB	-rwxr-xr-x
class-wp-rest-font-faces-controller.php	29.11 KB	-rwxr-xr-x
class-wp-rest-font-families-controller.php	17.1 KB	-rwxr-xr-x
class-wp-rest-global-styles-controller.php	20.58 KB	-rwxr-xr-x
class-wp-rest-global-styles-revisions-controller.php	12.62 KB	-rwxr-xr-x
class-wp-rest-menu-items-controller.php	32.49 KB	-rwxr-xr-x
class-wp-rest-menu-locations-controller.php	8.75 KB	-rwxr-xr-x
class-wp-rest-menus-controller.php	16.68 KB	-rwxr-xr-x
class-wp-rest-navigation-fallback-controller.php	5.05 KB	-rwxr-xr-x
class-wp-rest-pattern-directory-controller.php	12.64 KB	-rwxr-xr-x
class-wp-rest-plugins-controller.php	27.86 KB	-rwxr-xr-x
class-wp-rest-post-statuses-controller.php	10.07 KB	-rwxr-xr-x
class-wp-rest-post-types-controller.php	13.95 KB	-rwxr-xr-x
class-wp-rest-posts-controller.php	100.05 KB	-rwxr-xr-x
class-wp-rest-revisions-controller.php	26.17 KB	-rwxr-xr-x
class-wp-rest-search-controller.php	11.21 KB	-rwxr-xr-x
class-wp-rest-settings-controller.php	10.11 KB	-rwxr-xr-x
class-wp-rest-sidebars-controller.php	15.82 KB	-rwxr-xr-x
class-wp-rest-site-health-controller.php	9.61 KB	-rwxr-xr-x
class-wp-rest-taxonomies-controller.php	13.69 KB	-rwxr-xr-x
class-wp-rest-template-autosaves-controller.php	7.64 KB	-rwxr-xr-x
class-wp-rest-template-revisions-controller.php	8.52 KB	-rwxr-xr-x
class-wp-rest-templates-controller.php	37.41 KB	-rwxr-xr-x
class-wp-rest-terms-controller.php	34.61 KB	-rwxr-xr-x
class-wp-rest-themes-controller.php	22.77 KB	-rwxr-xr-x
class-wp-rest-url-details-controller.php	20.07 KB	-rwxr-xr-x
class-wp-rest-users-controller.php	48.72 KB	-rwxr-xr-x
class-wp-rest-widget-types-controller.php	18.78 KB	-rwxr-xr-x
class-wp-rest-widgets-controller.php	26.26 KB	-rwxr-xr-x

Code Editor : class-wp-rest-abilities-v1-run-controller.php

<?php
/**
 * REST API run controller for Abilities API.
 *
 * @package WordPress
 * @subpackage Abilities_API
 * @since 6.9.0
 */

declare( strict_types = 1 );

/**
 * Core controller used to execute abilities via the REST API.
 *
 * @since 6.9.0
 *
 * @see WP_REST_Controller
 */
class WP_REST_Abilities_V1_Run_Controller extends WP_REST_Controller {

/**
	 * REST API namespace.
	 *
	 * @since 6.9.0
	 * @var string
	 */
	protected $namespace = 'wp-abilities/v1';

/**
	 * REST API base route.
	 *
	 * @since 6.9.0
	 * @var string
	 */
	protected $rest_base = 'abilities';

/**
	 * Registers the routes for ability execution.
	 *
	 * @since 6.9.0
	 *
	 * @see register_rest_route()
	 */
	public function register_routes(): void {
		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base . '/(?P<name>[a-zA-Z0-9\-\/]+?)/run',
			array(
				'args'   => array(
					'name' => array(
						'description' => __( 'Unique identifier for the ability.' ),
						'type'        => 'string',
						'pattern'     => '^[a-zA-Z0-9\-\/]+$',
					),
				),

// TODO: We register ALLMETHODS because at route registration time, we don't know which abilities
				// exist or their annotations (`destructive`, `idempotent`, `readonly`). This is due to WordPress
				// load order - routes are registered early, before plugins have registered their abilities.
				// This approach works but could be improved with lazy route registration or a different
				// architecture that allows type-specific routes after abilities are registered.
				// This was the same issue that we ended up seeing with the Feature API.
				array(
					'methods'             => WP_REST_Server::ALLMETHODS,
					'callback'            => array( $this, 'execute_ability' ),
					'permission_callback' => array( $this, 'check_ability_permissions' ),
					'args'                => $this->get_run_args(),
				),
				'schema' => array( $this, 'get_run_schema' ),
			)
		);
	}

/**
	 * Executes an ability.
	 *
	 * @since 6.9.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */
	public function execute_ability( $request ) {
		$ability = wp_get_ability( $request['name'] );
		if ( ! $ability ) {
			return new WP_Error(
				'rest_ability_not_found',
				__( 'Ability not found.' ),
				array( 'status' => 404 )
			);
		}

$input  = $this->get_input_from_request( $request );
		$result = $ability->execute( $input );
		if ( is_wp_error( $result ) ) {
			return $result;
		}

return rest_ensure_response( $result );
	}

/**
	 * Validates if the HTTP method matches the expected method for the ability based on its annotations.
	 *
	 * @since 6.9.0
	 *
	 * @param string                     $request_method The HTTP method of the request.
	 * @param array<string, (null|bool)> $annotations    The ability annotations.
	 * @return true|WP_Error True on success, or WP_Error object on failure.
	 */
	public function validate_request_method( string $request_method, array $annotations ) {
		$expected_method = 'POST';
		if ( ! empty( $annotations['readonly'] ) ) {
			$expected_method = 'GET';
		} elseif ( ! empty( $annotations['destructive'] ) && ! empty( $annotations['idempotent'] ) ) {
			$expected_method = 'DELETE';
		}

if ( $expected_method === $request_method ) {
			return true;
		}

$error_message = __( 'Abilities that perform updates require POST method.' );
		if ( 'GET' === $expected_method ) {
			$error_message = __( 'Read-only abilities require GET method.' );
		} elseif ( 'DELETE' === $expected_method ) {
			$error_message = __( 'Abilities that perform destructive actions require DELETE method.' );
		}
		return new WP_Error(
			'rest_ability_invalid_method',
			$error_message,
			array( 'status' => 405 )
		);
	}

/**
	 * Checks if a given request has permission to execute a specific ability.
	 *
	 * @since 6.9.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return true|WP_Error True if the request has execution permission, WP_Error object otherwise.
	 */
	public function check_ability_permissions( $request ) {
		$ability = wp_get_ability( $request['name'] );
		if ( ! $ability || ! $ability->get_meta_item( 'show_in_rest' ) ) {
			return new WP_Error(
				'rest_ability_not_found',
				__( 'Ability not found.' ),
				array( 'status' => 404 )
			);
		}

$is_valid = $this->validate_request_method(
			$request->get_method(),
			$ability->get_meta_item( 'annotations' )
		);
		if ( is_wp_error( $is_valid ) ) {
			return $is_valid;
		}

$input    = $this->get_input_from_request( $request );
		$input    = $ability->normalize_input( $input );
		$is_valid = $ability->validate_input( $input );
		if ( is_wp_error( $is_valid ) ) {
			$is_valid->add_data( array( 'status' => 400 ) );
			return $is_valid;
		}

$result = $ability->check_permissions( $input );
		if ( is_wp_error( $result ) ) {
			$result->add_data( array( 'status' => rest_authorization_required_code() ) );
			return $result;
		}
		if ( ! $result ) {
			return new WP_Error(
				'rest_ability_cannot_execute',
				__( 'Sorry, you are not allowed to execute this ability.' ),
				array( 'status' => rest_authorization_required_code() )
			);
		}

return true;
	}

/**
	 * Extracts input parameters from the request.
	 *
	 * @since 6.9.0
	 *
	 * @param WP_REST_Request $request The request object.
	 * @return mixed|null The input parameters.
	 */
	private function get_input_from_request( $request ) {
		if ( in_array( $request->get_method(), array( 'GET', 'DELETE' ), true ) ) {
			// For GET and DELETE requests, look for 'input' query parameter.
			$query_params = $request->get_query_params();
			return $query_params['input'] ?? null;
		}

// For POST requests, look for 'input' in JSON body.
		$json_params = $request->get_json_params();
		return $json_params['input'] ?? null;
	}

/**
	 * Retrieves the arguments for ability execution endpoint.
	 *
	 * @since 6.9.0
	 *
	 * @return array<string, mixed> Arguments for the run endpoint.
	 */
	public function get_run_args(): array {
		return array(
			'input' => array(
				'description' => __( 'Input parameters for the ability execution.' ),
				'type'        => array( 'integer', 'number', 'boolean', 'string', 'array', 'object', 'null' ),
				'default'     => null,
			),
		);
	}

/**
	 * Retrieves the schema for ability execution endpoint.
	 *
	 * @since 6.9.0
	 *
	 * @return array<string, mixed> Schema for the run endpoint.
	 */
	public function get_run_schema(): array {
		return array(
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => 'ability-execution',
			'type'       => 'object',
			'properties' => array(
				'result' => array(
					'description' => __( 'The result of the ability execution.' ),
					'type'        => array( 'integer', 'number', 'boolean', 'string', 'array', 'object', 'null' ),
					'context'     => array( 'view', 'edit' ),
					'readonly'    => true,
				),
			),
		);
	}
}

${this.title}

Code Editor : class-wp-rest-abilities-v1-run-controller.php