Refactor flip parameters in WP REST Attachments Controller to use boolean values instead of integers. Update related tests to reflect changes in parameter types and description

Author: ramonjd

src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -587,8 +587,8 @@ public function edit_media_item( $request ) {
 
 			if ( isset( $request['flip']['horizontal'] ) || isset( $request['flip']['vertical'] ) ) {
 				$flip_args = array(
-					'vertical'   => $request['flip']['vertical'] ?? 0,
-					'horizontal' => $request['flip']['horizontal'] ?? 0,
+					'vertical'   => isset( $request['flip']['vertical'] ) ? (bool) $request['flip']['vertical'] : false,
+					'horizontal' => isset( $request['flip']['horizontal'] ) ? (bool) $request['flip']['horizontal'] : false,
 				);
 
 				$modifiers[] = array(
@@ -658,7 +658,7 @@ public function edit_media_item( $request ) {
 					 * The vertical flip is the first argument (flip along horizontal axis), the horizontal flip is the second argument (flip along vertical axis).
 					 * See: WP_Image_Editor::flip()
 					 */
-					$result = $image_editor->flip( 0 !== (int) $args['flip']['vertical'], 0 !== (int) $args['flip']['horizontal'] );
+					$result = $image_editor->flip( $args['flip']['vertical'], $args['flip']['horizontal'] );
 					if ( is_wp_error( $result ) ) {
 						return new WP_Error(
 							'rest_image_flip_failed',
@@ -1558,20 +1558,20 @@ protected function get_edit_media_item_args() {
 									),
 									'properties'  => array(
 										'flip' => array(
-											'description' => __( 'Flip direction. [ horizontal, vertical ] 0 for no flip, 1 for flip.' ),
+											'description' => __( 'Flip direction. [ horizontal, vertical ]' ),
 											'type'        => 'object',
 											'required'    => array(
 												'horizontal',
 												'vertical',
 											),
 											'properties'  => array(
 												'horizontal' => array(
-													'description' => __( 'Horizontal flip direction. 0 for no flip, 1 for flip.' ),
-													'type' => 'number',
+													'description' => __( 'Whether to flip in the horizontal direction.' ),
+													'type' => 'boolean',
 												),
 												'vertical' => array(
-													'description' => __( 'Vertical flip direction. 0 for no flip, 1 for flip.' ),
-													'type' => 'number',
+													'description' => __( 'Whether to flip in the vertical direction.' ),
+													'type' => 'boolean',
 												),
 											),
 										),

tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -2751,8 +2751,8 @@ public function test_edit_image_vertical_and_horizontal_flip() {
 
 		$params = array(
 			'flip' => array(
-				'vertical'   => 1,
-				'horizontal' => 1,
+				'vertical'   => true,
+				'horizontal' => true,
 			),
 			'src'  => wp_get_attachment_image_url( $attachment, 'full' ),
 		);
@@ -2768,12 +2768,12 @@ public function test_edit_image_vertical_and_horizontal_flip() {
 	}
 
 	/**
-	 * Tests that the image is flipped correctly vertically.
+	 * Tests that the image is flipped correctly vertically only.
 	 *
 	 * @ticket 64035
 	 * @requires function imagejpeg
 	 */
-	public function test_edit_image_vertical_flip() {
+	public function test_edit_image_vertical_flip_with_horizontal_false() {
 		wp_set_current_user( self::$superadmin_id );
 		$attachment = self::factory()->attachment->create_upload_object( self::$test_file );
 
@@ -2782,7 +2782,38 @@ public function test_edit_image_vertical_flip() {
 
 		$params = array(
 			'flip' => array(
-				'vertical' => 1,
+				'vertical'   => true,
+				'horizontal' => false,
+			),
+			'src'  => wp_get_attachment_image_url( $attachment, 'full' ),
+		);
+
+		$request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
+		$request->set_body_params( $params );
+		$response = rest_do_request( $request );
+		$this->assertErrorResponse( 'rest_image_flip_failed', $response, 500 );
+
+		$this->assertCount( 1, WP_Image_Editor_Mock::$spy['flip'] );
+		// The controller converts the integer values to booleans: 0 !== (int) 1 = true.
+		$this->assertSame( array( true, false ), WP_Image_Editor_Mock::$spy['flip'][0], 'Vertical flip of the image is not identical.' );
+	}	
+
+	/**
+	 * Tests that the image is flipped correctly with only vertical flip in arguments.
+	 *
+	 * @ticket 64035
+	 * @requires function imagejpeg
+	 */
+	public function test_edit_image_vertical_flip_only() {
+		wp_set_current_user( self::$superadmin_id );
+		$attachment = self::factory()->attachment->create_upload_object( self::$test_file );
+
+		$this->setup_mock_editor();
+		WP_Image_Editor_Mock::$edit_return['flip'] = new WP_Error();
+
+		$params = array(
+			'flip' => array(
+				'vertical' => true,
 			),
 			'src'  => wp_get_attachment_image_url( $attachment, 'full' ),
 		);

tests/qunit/fixtures/wp-api-generated.js

@@ -3445,20 +3445,20 @@ mockedApiResponse.Schema = {
                                                 ],
                                                 "properties": {
                                                     "flip": {
-                                                        "description": "Flip direction. [ horizontal, vertical ] 0 for no flip, 1 for flip.",
+                                                        "description": "Flip direction. [ horizontal, vertical ]",
                                                         "type": "object",
                                                         "required": [
                                                             "horizontal",
                                                             "vertical"
                                                         ],
                                                         "properties": {
                                                             "horizontal": {
-                                                                "description": "Horizontal flip direction. 0 for no flip, 1 for flip.",
-                                                                "type": "number"
+                                                                "description": "Whether to flip in the horizontal direction.",
+                                                                "type": "boolean"
                                                             },
                                                             "vertical": {
-                                                                "description": "Vertical flip direction. 0 for no flip, 1 for flip.",
-                                                                "type": "number"
+                                                                "description": "Whether to flip in the vertical direction.",
+                                                                "type": "boolean"
                                                             }
                                                         }
                                                     }