Automattic\WooCommerce\Internal\RestApi\Routes\V4\Settings\PaymentGateways\Schema

CodGatewaySettingsSchema{} │ WC 1.0└─ AbstractPaymentGatewaySettingsSchema

CodGatewaySettingsSchema class.

Extends AbstractPaymentGatewaySettingsSchema for Cash on Delivery payment gateway with design-aligned field labels and descriptions.

No Hooks.

Usage

$CodGatewaySettingsSchema = new CodGatewaySettingsSchema();
// use class methods

Methods

1. protected get_custom_groups_for_gateway( WC_Payment_Gateway $gateway )
2. private load_shipping_method_options()

CodGatewaySettingsSchema{} CodGatewaySettingsSchema{} code ^{WC 10.7.0}

class CodGatewaySettingsSchema extends AbstractPaymentGatewaySettingsSchema {

	/**
	 * Cached shipping method options.
	 *
	 * @var ?array
	 */
	private ?array $shipping_method_options = null;

	/**
	 * Get custom groups for the COD gateway.
	 *
	 * Provides design-aligned labels and descriptions for the cash on delivery
	 * settings form fields. Derives fields from the gateway's form_fields
	 * to preserve any extension-injected settings.
	 *
	 * @param WC_Payment_Gateway $gateway Gateway instance.
	 * @return array Custom group structure.
	 */
	protected function get_custom_groups_for_gateway( WC_Payment_Gateway $gateway ): array {
		// Design-aligned overrides for core fields.
		$core_field_overrides = array(
			'enabled'            => array(
				'label' => __( 'Enable/Disable', 'woocommerce' ),
				'type'  => 'checkbox',
				'desc'  => __( 'Enable Cash on delivery at checkout', 'woocommerce' ),
			),
			'title'              => array(
				'label' => __( 'Checkout label', 'woocommerce' ),
				'type'  => 'text',
				'desc'  => __( 'Shown to customers on the payment methods list at checkout.', 'woocommerce' ),
			),
			'description'        => array(
				'label' => __( 'Checkout instructions', 'woocommerce' ),
				'type'  => 'text',
				'desc'  => __( 'Shown below the checkout label.', 'woocommerce' ),
			),
			'order'              => array(
				'label' => __( 'Order', 'woocommerce' ),
				'type'  => 'number',
				'desc'  => __( 'Determines the display order of payment gateways during checkout.', 'woocommerce' ),
			),
			'instructions'       => array(
				'label' => __( 'Order confirmation instructions', 'woocommerce' ),
				'type'  => 'text',
				'desc'  => __( 'Shown on the order confirmation page and in order emails.', 'woocommerce' ),
			),
			'enable_for_methods' => array(
				'label'   => __( 'Available for shipping methods', 'woocommerce' ),
				'type'    => 'multiselect',
				'desc'    => __( 'Choose which shipping methods support Cash on delivery.', 'woocommerce' ),
				'options' => $this->load_shipping_method_options(),
			),
			'enable_for_virtual' => array(
				'label' => __( 'Accept for virtual orders', 'woocommerce' ),
				'type'  => 'checkbox',
				'desc'  => __( 'Accept COD if the order is virtual', 'woocommerce' ),
			),
		);

		$fields = $this->build_fields_from_form_fields( $gateway, $core_field_overrides );

		$group = array(
			'title'       => __( 'Cash on delivery settings', 'woocommerce' ),
			'description' => __( 'Manage how Cash on delivery appears at checkout and in order emails.', 'woocommerce' ),
			'order'       => 1,
			'fields'      => $fields,
		);

		return array( 'settings' => $group );
	}

	/**
	 * Load all shipping method options for the enable_for_methods field.
	 *
	 * This method replicates the logic from WC_Gateway_COD::load_shipping_method_options()
	 * to provide shipping method options for the REST API without relying on the gateway class.
	 *
	 * Unlike the original, the is_accessing_settings() guard is intentionally omitted:
	 * the REST API endpoint always needs options populated, and the instance-level cache
	 * prevents redundant computation within a single request.
	 *
	 * @return array Nested array of shipping method options.
	 */
	private function load_shipping_method_options(): array {
		if ( null !== $this->shipping_method_options ) {
			return $this->shipping_method_options;
		}

		$data_store = WC_Data_Store::load( 'shipping-zone' );
		$raw_zones  = $data_store->get_zones();
		$zones      = array();

		foreach ( $raw_zones as $raw_zone ) {
			$zones[] = new WC_Shipping_Zone( $raw_zone );
		}

		$zones[] = new WC_Shipping_Zone( 0 );

		$options = array();
		foreach ( WC()->shipping()->load_shipping_methods() as $method ) {

			$options[ $method->get_method_title() ] = array();

			// Translators: %1$s shipping method name.
			$options[ $method->get_method_title() ][ $method->id ] = sprintf( __( 'Any "%1$s" method', 'woocommerce' ), $method->get_method_title() );

			foreach ( $zones as $zone ) {

				$shipping_method_instances = $zone->get_shipping_methods();

				foreach ( $shipping_method_instances as $shipping_method_instance_id => $shipping_method_instance ) {

					if ( $shipping_method_instance->id !== $method->id ) {
						continue;
					}

					$option_id = $shipping_method_instance->get_rate_id();

					// Translators: %1$s shipping method title, %2$s shipping method id.
					$option_instance_title = sprintf( __( '%1$s (#%2$s)', 'woocommerce' ), $shipping_method_instance->get_title(), $shipping_method_instance_id );

					// Translators: %1$s zone name, %2$s shipping method instance name.
					$option_title = sprintf( __( '%1$s – %2$s', 'woocommerce' ), $zone->get_id() ? $zone->get_zone_name() : __( 'Other locations', 'woocommerce' ), $option_instance_title );

					$options[ $method->get_method_title() ][ $option_id ] = $option_title;
				}
			}
		}

		$this->shipping_method_options = $options;

		return $options;
	}
}