Automattic\WooCommerce\Internal\Abilities\Domain

OrderUpdateStatus::get_input_schema │ private static │ WC 1.0

Get the ability input schema.

Method of the class: OrderUpdateStatus{}

No Hooks.

Returns

Array.

Usage

$result = OrderUpdateStatus::get_input_schema(): array;

OrderUpdateStatus::get_input_schema() OrderUpdateStatus::get input schema code ^{WC 11.0.1}

private static function get_input_schema(): array {
	return array(
		'type'                 => 'object',
		'properties'           => array(
			'id'     => array(
				'type'    => 'integer',
				'minimum' => 1,
			),
			'status' => array(
				'type'        => 'string',
				'description' => __( 'Order status slug without the wc- prefix.', 'woocommerce' ),
				'enum'        => self::get_allowed_order_status_slugs(),
			),
			'note'   => array(
				'type'        => 'string',
				'description' => __( 'Optional status change note. Safe HTML is allowed. Use the woocommerce/order-add-note ability for notes without a status change.', 'woocommerce' ),
			),
		),
		'required'             => array( 'id', 'status' ),
		'additionalProperties' => false,
	);
}