fix: Add type hints to REST API controller methods

Author: emdashcodes

src/rest/class-wp-rest-abilities-list-controller.php

@@ -101,7 +101,7 @@ public function register_routes(): void {
 	 * @param \WP_REST_Request $request Full details about the request.
 	 * @return \WP_REST_Response Response object on success.
 	 */
-	public function get_items( $request ) {
+	public function get_items( \WP_REST_Request $request ): \WP_REST_Response {
 		// TODO: Add HEAD method support for performance optimization.
 		// Should return early with empty body but include X-WP-Total and X-WP-TotalPages headers.
 		// See: https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php#L316-L318
@@ -155,7 +155,7 @@ public function get_items( $request ) {
 	 * @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 get_item( $request ) {
+	public function get_item( \WP_REST_Request $request ) {
 		$ability = wp_get_ability( $request['name'] );
 
 		if ( ! $ability ) {
@@ -178,7 +178,7 @@ public function get_item( $request ) {
 	 * @param \WP_REST_Request $request Full details about the request.
 	 * @return boolean True if the request has read access.
 	 */
-	public function get_permissions_check( $request ) {
+	public function get_permissions_check( \WP_REST_Request $request ): bool {
 		return current_user_can( 'read' );
 	}
 
@@ -191,7 +191,7 @@ public function get_permissions_check( $request ) {
 	 * @param \WP_REST_Request $request Request object.
 	 * @return \WP_REST_Response Response object.
 	 */
-	public function prepare_item_for_response( $ability, $request ) {
+	public function prepare_item_for_response( \WP_Ability $ability, \WP_REST_Request $request ): \WP_REST_Response {
 		$data = array(
 			'name'          => $ability->get_name(),
 			'label'         => $ability->get_label(),
@@ -278,7 +278,7 @@ public function get_item_schema(): array {
 					'readonly'    => true,
 				),
 			),
-			'required' => array( 'name', 'label', 'description' ),
+			'required'   => array( 'name', 'label', 'description' ),
 		);
 
 		return $this->add_additional_fields_schema( $schema );

src/rest/class-wp-rest-abilities-run-controller.php

@@ -87,7 +87,7 @@ public function register_routes(): void {
 	 * @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 run_ability_with_method_check( $request ) {
+	public function run_ability_with_method_check( \WP_REST_Request $request ) {
 		$ability = wp_get_ability( $request['name'] );
 
 		if ( ! $ability ) {
@@ -130,7 +130,7 @@ public function run_ability_with_method_check( $request ) {
 	 * @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 run_ability( $request ) {
+	public function run_ability( \WP_REST_Request $request ) {
 		$ability = wp_get_ability( $request['name'] );
 
 		if ( ! $ability ) {
@@ -186,7 +186,7 @@ public function run_ability( $request ) {
 	 * @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 run_ability_permissions_check( $request ) {
+	public function run_ability_permissions_check( \WP_REST_Request $request ) {
 		$ability = wp_get_ability( $request['name'] );
 
 		if ( ! $ability ) {
@@ -219,7 +219,7 @@ public function run_ability_permissions_check( $request ) {
 	 * @param array<string, mixed> $input   The input data to validate.
 	 * @return true|\WP_Error True if validation passes, WP_Error object on failure.
 	 */
-	private function validate_input( $ability, $input ) {
+	private function validate_input( \WP_Ability $ability, array $input ) {
 		$input_schema = $ability->get_input_schema();
 
 		if ( empty( $input_schema ) ) {
@@ -251,7 +251,7 @@ private function validate_input( $ability, $input ) {
 	 * @param mixed       $output  The output data to validate.
 	 * @return true|\WP_Error True if validation passes, WP_Error object on failure.
 	 */
-	private function validate_output( $ability, $output ) {
+	private function validate_output( \WP_Ability $ability, $output ) {
 		$output_schema = $ability->get_output_schema();
 
 		if ( empty( $output_schema ) ) {
@@ -282,7 +282,7 @@ private function validate_output( $ability, $output ) {
 	 * @param \WP_REST_Request $request The request object.
 	 * @return array<string, mixed> The input parameters.
 	 */
-	private function get_input_from_request( $request ) {
+	private function get_input_from_request( \WP_REST_Request $request ): array {
 		if ( 'GET' === $request->get_method() ) {
 			// For GET requests, look for 'input' query parameter.
 			$query_params = $request->get_query_params();