get_item_schema(); } /** * Register the routes for payment gateways. */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P[\w-]+)', array( array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_item' ), 'permission_callback' => array( $this, 'get_items_permissions_check' ), ), array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'update_item' ), 'permission_callback' => array( $this, 'update_item_permissions_check' ), 'args' => array( 'enabled' => array( 'description' => __( 'Gateway enabled status.', 'woocommerce' ), 'type' => 'boolean', 'required' => false, ), 'title' => array( 'description' => __( 'Gateway title.', 'woocommerce' ), 'type' => 'string', 'required' => false, ), 'description' => array( 'description' => __( 'Gateway description.', 'woocommerce' ), 'type' => 'string', 'required' => false, ), 'order' => array( 'description' => __( 'Gateway sort order.', 'woocommerce' ), 'type' => 'integer', 'required' => false, ), 'values' => array( 'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ), 'type' => 'object', 'required' => false, ), ), ), 'schema' => array( $this, 'get_public_item_schema' ), 'args' => array( 'id' => array( 'description' => __( 'Unique identifier for the resource.', 'woocommerce' ), 'type' => 'string', 'pattern' => '^[\w-]+$', ), ), ) ); } /** * Get a single payment gateway. * * @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 ) { $id = $request['id']; $payment_gateways = WC()->payment_gateways->payment_gateways(); if ( ! isset( $payment_gateways[ $id ] ) ) { return new WP_Error( 'woocommerce_rest_payment_gateway_invalid_id', __( 'Invalid payment gateway ID.', 'woocommerce' ), array( 'status' => 404 ) ); } $gateway = $payment_gateways[ $id ]; // Get gateway-specific schema. $schema = $this->get_schema_for_gateway( $id ); $data = $schema->get_item_response( $gateway, $request ); return rest_ensure_response( $data ); } /** * Check if a given request has access to read payment gateways. * * @param WP_REST_Request $request Full details about the request. * @return WP_Error|boolean */ public function get_items_permissions_check( $request ) { if ( ! wc_rest_check_manager_permissions( $this->post_type, 'read' ) ) { return $this->get_authentication_error_by_method( $request->get_method() ); } return true; } /** * Check if a given request has access to update payment gateways. * * @param WP_REST_Request $request Full details about the request. * @return WP_Error|boolean */ public function update_item_permissions_check( $request ) { if ( ! wc_rest_check_manager_permissions( 'payment_gateways', 'edit' ) ) { return $this->get_authentication_error_by_method( $request->get_method() ); } return true; } /** * Get a gateway based on the current request object. * * @param string $id Gateway ID. * * @return WC_Payment_Gateway|null */ private function get_payment_gateway( $id ): ?WC_Payment_Gateway { $payment_gateways = WC()->payment_gateways->payment_gateways(); return $payment_gateways[ $id ] ?? null; } /** * Get the appropriate schema for a payment gateway. * * @param string $gateway_id Gateway ID. * @return AbstractPaymentGatewaySettingsSchema */ private function get_schema_for_gateway( string $gateway_id ): AbstractPaymentGatewaySettingsSchema { switch ( $gateway_id ) { case 'bacs': return new BacsGatewaySettingsSchema(); case 'cheque': return new ChequeGatewaySettingsSchema(); case 'cod': return new CodGatewaySettingsSchema(); default: // Use generic schema for unknown gateways. return new PaymentGatewaySettingsSchema(); } } /** * Update a payment gateway's settings. * * @param WP_REST_Request $request Full details about the request. * @return WP_REST_Response|WP_Error */ public function update_item( $request ) { $id = $request['id']; $gateway = $this->get_payment_gateway( $id ); if ( ! $gateway ) { return new WP_Error( 'woocommerce_rest_payment_gateway_invalid_id', __( 'Invalid payment gateway ID.', 'woocommerce' ), array( 'status' => 404 ) ); } // Get gateway-specific schema. $schema = $this->get_schema_for_gateway( $id ); // Get field values from the values parameter (for gateway-specific settings). $params = $request->get_params(); $values_to_update = $params['values'] ?? array(); if ( ! is_array( $values_to_update ) ) { $values_to_update = array(); } // Handle top-level gateway fields. Accept both top-level params // (core-data sends edits this way) and values.* (legacy/form saves). // Top-level takes precedence when both are present. $gateway->init_form_fields(); $enabled = $params['enabled'] ?? $values_to_update['enabled'] ?? null; if ( null !== $enabled ) { $gateway->enabled = wc_bool_to_string( $enabled ); $gateway->settings['enabled'] = $gateway->enabled; unset( $values_to_update['enabled'] ); } $title = $params['title'] ?? $values_to_update['title'] ?? null; if ( null !== $title ) { $gateway->title = sanitize_text_field( $title ); $gateway->settings['title'] = $gateway->title; unset( $values_to_update['title'] ); } $description = $params['description'] ?? $values_to_update['description'] ?? null; if ( null !== $description ) { $gateway->description = wp_kses_post( $description ); $gateway->settings['description'] = $gateway->description; unset( $values_to_update['description'] ); } $order_to_update = null; $order_value = $params['order'] ?? $values_to_update['order'] ?? null; if ( null !== $order_value ) { $order_to_update = absint( $order_value ); unset( $values_to_update['order'] ); } // Separate standard fields from special fields. $standard_values = array(); $special_values = array(); foreach ( $values_to_update as $key => $value ) { // Check if this is a special field. if ( $schema->is_special_field( $key ) ) { $special_values[ $key ] = $value; } elseif ( isset( $gateway->form_fields[ $key ] ) ) { $standard_values[ $key ] = $value; } // Silently skip unknown fields. } // Validate and sanitize standard settings. $validated_settings = $schema->validate_and_sanitize_settings( $gateway, $standard_values ); if ( is_wp_error( $validated_settings ) ) { return $validated_settings; } // Validate and sanitize special fields. $validated_special = $schema->validate_and_sanitize_special_fields( $gateway, $special_values ); if ( is_wp_error( $validated_special ) ) { return $validated_special; } // Update standard settings. foreach ( $validated_settings as $key => $value ) { $gateway->settings[ $key ] = $value; } // Save standard settings to database. update_option( $gateway->get_option_key(), $gateway->settings ); // Save gateway order (deferred until after validation). if ( null !== $order_to_update ) { $gateway_order = (array) get_option( 'woocommerce_gateway_order', array() ); $gateway_order[ $id ] = $order_to_update; update_option( 'woocommerce_gateway_order', $gateway_order ); } // Update special fields. $schema->update_special_fields( $gateway, $validated_special ); // Return updated gateway data. $data = $schema->get_item_response( $gateway, $request ); return rest_ensure_response( $data ); } /** * Get the item response for a payment gateway. * * @param WC_Payment_Gateway $item Payment gateway object. * @param WP_REST_Request $request Request object. * @return array The item response. */ protected function get_item_response( $item, WP_REST_Request $request ): array { // Get gateway-specific schema. $schema = $this->get_schema_for_gateway( $item->id ); return $schema->get_item_response( $item, $request ); } }