Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add featured field to the schema with tests

This commit is contained in:
Csaba Maulis 2023-04-20 13:14:02 +08:00
parent 7c9ae871c3
commit 135d6f2b27
No known key found for this signature in database
GPG Key ID: 078894AC01BC6E63
2 changed files with 55 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
plugins/woocommerce/includes/rest-api/Controllers/Version3/class-wc-rest-products-controller.php
View File

@ -1256,6 +1256,12 @@ class WC_REST_Products_Controller extends WC_REST_Products_V2_Controller {
'type' => 'integer', 'type' => 'integer',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
), ),
'featured' => array(
'description' => __( 'Featured image.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'date_created' => array( 'date_created' => array(
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ), 'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time', 'type' => 'date-time',

50
plugins/woocommerce/tests/php/includes/rest-api/Controllers/Version3/class-wc-rest-products-controller-tests.php
View File

@ -205,7 +205,55 @@ class WC_REST_Products_Controller_Tests extends WC_REST_Unit_Test_Case {
} }
/** /**
* Test that all fields are returned when requested one by one. * Test that featured field exists under images in product argument.
*/
public function test_products_args_includes_featured_field() {
$request = new WP_REST_Request( 'OPTIONS', '/wc/v3/products' );
$request->set_param( '_fields', 'endpoints.1.args.images.items.properties' );
$response = $this->server->dispatch( $request );
$image_arg = $response->get_data()['endpoints'][1]['args']['images']['items']['properties'];
$this->assertArrayHasKey( 'featured', $image_arg );
$this->assertEquals(
array(
'description' => 'Featured image.',
'type' => 'boolean',
'default' => false,
'context' =>
array(
0 => 'view',
1 => 'edit',
),
),
$image_arg['featured']
);
}
/**
* Test that featured field exists under images in product schema.
*/
public function test_products_schema_includes_featured_field() {
$request = new WP_REST_Request( 'OPTIONS', '/wc/v3/products' );
$request->set_param( '_fields', 'schema.properties.images.items.properties' );
$response = $this->server->dispatch( $request );
$image_schema = $response->get_data()['schema']['properties']['images']['items']['properties'];
$this->assertArrayHasKey( 'featured', $image_schema );
$this->assertEquals(
array(
'description' => 'Featured image.',
'type' => 'boolean',
'default' => false,
'context' =>
array(
0 => 'view',
1 => 'edit',
),
),
$image_schema['featured']
);
}
/**
* Test that feature field is returned inside images.
*/ */
public function test_products_get_images_array_contains_featured() { public function test_products_get_images_array_contains_featured() {
global $wpdb; global $wpdb;