Add a settings bulk update for updating settings in multiple groups.

Author: Justin Shreve

api/class-wc-rest-dev-settings-controller.php

@@ -4,10 +4,9 @@
  *
  * Handles requests to the /settings endpoints.
  *
- * @author   WooThemes
+ * @author   Automattic
  * @category API
  * @package  WooCommerce/API
- * @since    3.0.0
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
@@ -26,4 +25,45 @@ class WC_REST_Dev_Settings_Controller extends WC_REST_Settings_Controller {
 	 */
 	protected $namespace = 'wc/v3';
 
+	/**
+	 * Register routes.
+	 *
+	 */
+	public function register_routes() {
+		parent::register_routes();
+		register_rest_route( $this->namespace, '/' . $this->rest_base . '/batch', array(
+			array(
+				'methods'             => WP_REST_Server::EDITABLE,
+				'callback'            => array( $this, 'batch_items' ),
+				'permission_callback' => array( $this, 'update_items_permissions_check' ),
+			),
+			'schema' => array( $this, 'get_public_batch_schema' ),
+		) );
+	}
+
+	/**
+	 * Makes sure the current user has access to WRITE the settings APIs.
+	 *
+	 * @param WP_REST_Request $request Full data about the request.
+	 * @return WP_Error|boolean
+	 */
+	public function update_items_permissions_check( $request ) {
+		if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
+			return new WP_Error( 'woocommerce_rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
+		}
+
+		return true;
+	}
+
+	/**
+	 * Update a setting.
+	 *
+	 * @param  WP_REST_Request $request
+	 * @return WP_Error|WP_REST_Response
+	 */
+	public function update_item( $request ) {
+		$options_controller = new WC_REST_Setting_Options_Controller;
+		return $options_controller->update_item( $request );
+	}
+
 }

tests/unit-tests/functions.php

@@ -64,7 +64,7 @@ public function test_wc_rest_validate_reports_request_arg() {
 	 * @since 2.6.0
 	 */
 	public function test_wc_rest_urlencode_rfc3986() {
-		$this->assertEquals( 'https%253A%252F%252Fwoocommerce.com%252F', wc_rest_urlencode_rfc3986( 'https://woocommerce.com/' ) );
+		$this->assertEquals( 'https%3A%2F%2Fwoocommerce.com%2F', wc_rest_urlencode_rfc3986( 'https://woocommerce.com/' ) );
 	}
 
 	/**

tests/unit-tests/settings.php

@@ -28,7 +28,9 @@ public function setUp() {
 	public function test_register_routes() {
 		$routes = $this->server->get_routes();
 		$this->assertArrayHasKey( '/wc/v3/settings', $routes );
+		$this->assertArrayHasKey( '/wc/v3/settings/batch', $routes );
 		$this->assertArrayHasKey( '/wc/v3/settings/(?P<group_id>[\w-]+)', $routes );
+		$this->assertArrayHasKey( '/wc/v3/settings/(?P<group_id>[\w-]+)/batch', $routes );
 		$this->assertArrayHasKey( '/wc/v3/settings/(?P<group_id>[\w-]+)/(?P<id>[\w-]+)', $routes );
 	}
 
@@ -285,6 +287,28 @@ public function test_update_settings() {
 		$this->assertEquals( 'both', $data['update'][0]['value'] );
 		$this->assertEquals( 'both', get_option( 'woocommerce_shop_page_display' ) );
 
+		// test bulk settings batch endpoint
+		$request = new WP_REST_Request( 'POST', '/wc/v3/settings/batch' );
+		$request->set_body_params( array(
+			'update' => array(
+				array(
+					'group_id' => 'test',
+					'id'       => 'woocommerce_shop_page_display',
+					'value'     => 'subcategories',
+				),
+				array(
+					'group_id' => 'products',
+					'id'       => 'woocommerce_dimension_unit',
+					'value'     => 'yd',
+				),
+			),
+		) );
+		$response = $this->server->dispatch( $request );
+		$data = $response->get_data();
+		$this->assertEquals( 'subcategories', $data['update'][0]['value'] );
+		$this->assertEquals( 'yd', $data['update'][1]['value'] );
+		$this->assertEquals( 'yd', get_option( 'woocommerce_dimension_unit' ) );
+
 		// test updating one, but making sure the other value stays the same
 		$request = new WP_REST_Request( 'POST', '/wc/v3/settings/test/batch' );
 		$request->set_body_params( array(
@@ -539,10 +563,10 @@ public function test_email_settings() {
 		$this->assertEquals( array(
 			'id'          => 'subject',
 			'label'       => 'Subject',
-			'description' => 'This controls the email subject line. Leave blank to use the default subject: <code>[{site_title}] New customer order ({order_number}) - {order_date}</code>.',
+			'description' => 'Available placeholders: <code>{site_title}, {order_date}, {order_number}</code>',
 			'type'        => 'text',
 			'default'     => '',
-			'tip'         => 'This controls the email subject line. Leave blank to use the default subject: <code>[{site_title}] New customer order ({order_number}) - {order_date}</code>.',
+			'tip'         => 'Available placeholders: <code>{site_title}, {order_date}, {order_number}</code>',
 			'value'       => '',
 		), $setting );
 
@@ -557,10 +581,10 @@ public function test_email_settings() {
 		$this->assertEquals( array(
 			'id'          => 'subject',
 			'label'       => 'Subject',
-			'description' => 'This controls the email subject line. Leave blank to use the default subject: <code>[{site_title}] New customer order ({order_number}) - {order_date}</code>.',
+			'description' => 'Available placeholders: <code>{site_title}, {order_date}, {order_number}</code>',
 			'type'        => 'text',
 			'default'     => '',
-			'tip'         => 'This controls the email subject line. Leave blank to use the default subject: <code>[{site_title}] New customer order ({order_number}) - {order_date}</code>.',
+			'tip'         => 'Available placeholders: <code>{site_title}, {order_date}, {order_number}</code>',
 			'value'       => 'This is my subject',
 		), $setting );