Automattic\WooCommerce\Admin\API

PaymentGatewaySuggestions::get_item_schema() │ public │ WC 1.0

Get the schema, conforming to JSON Schema.

Method of the class: PaymentGatewaySuggestions{}

No Hooks.

Return

Array.

Usage

$PaymentGatewaySuggestions = new PaymentGatewaySuggestions();
$PaymentGatewaySuggestions->get_item_schema();

PaymentGatewaySuggestions::get_item_schema() PaymentGatewaySuggestions::get item schema code ^{WC 9.7.1}

public function get_item_schema() {
	$schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'payment-gateway-suggestions',
		'type'       => 'object',
		'properties' => array(
			'content'                 => array(
				'description' => __( 'Suggestion description.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'id'                      => array(
				'description' => __( 'Suggestion ID.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'image'                   => array(
				'description' => __( 'Gateway image.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'is_visible'              => array(
				'description' => __( 'Suggestion visibility.', 'woocommerce' ),
				'type'        => 'boolean',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'plugins'                 => array(
				'description' => __( 'Array of plugin slugs.', 'woocommerce' ),
				'type'        => 'array',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'recommendation_priority' => array(
				'description' => __( 'Priority of recommendation.', 'woocommerce' ),
				'type'        => 'integer',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'title'                   => array(
				'description' => __( 'Gateway title.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'transaction_processors'  => array(
				'description'         => __( 'Array of transaction processors and their images.', 'woocommerce' ),
				'type'                => 'object',
				'addtionalProperties' => array(
					'type'   => 'string',
					'format' => 'uri',
				),
				'context'             => array( 'view', 'edit' ),
				'readonly'            => true,
			),
		),
	);

	return $this->add_additional_fields_schema( $schema );
}