Automattic\WooCommerce\Admin\Features\Blueprint\Steps

SetWCPaymentGateways::get_schema() │ public static │ WC 1.0

Get the schema for the step.

Method of the class: SetWCPaymentGateways{}

No Hooks.

Return

Array. The schema array.

Usage

$result = SetWCPaymentGateways::get_schema( $version ): array;

$version(int)

Optional version number of the schema.
Default: 1

SetWCPaymentGateways::get_schema() SetWCPaymentGateways::get schema code ^{WC 9.7.1}

public static function get_schema( $version = 1 ): array {
	return array(
		'type'       => 'object',
		'properties' => array(
			'step'             => array(
				'type' => 'string',
				'enum' => array( 'setWCPaymentGateways' ),
			),
			'payment_gateways' => array(
				'type'                 => 'object',
				'patternProperties'    => array(
					'^[a-zA-Z0-9_]+$' => array(
						'type'       => 'object',
						'properties' => array(
							'title'       => array(
								'type' => 'string',
							),
							'description' => array(
								'type' => 'string',
							),
							'enabled'     => array(
								'type' => 'string',
								'enum' => array( 'yes', 'no' ),
							),
						),
						'required'   => array( 'title', 'description', 'enabled' ),
					),
				),
				'additionalProperties' => false,
			),
		),
		'required'   => array( 'step', 'payment_gateways' ),
	);
}