Automattic\WooCommerce\Admin\API\Reports\Export

Controller::get_export_public_schema │ public │ WC 1.0

Get the Report Export's schema, conforming to JSON Schema.

Method of the class: Controller{}

No Hooks.

Returns

Array.

Usage

$Controller = new Controller();
$Controller->get_export_public_schema();

Controller::get_export_public_schema() Controller::get export public schema code ^{WC 10.4.3}

public function get_export_public_schema() {
	$schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'report_export',
		'type'       => 'object',
		'properties' => array(
			'status'    => array(
				'description' => __( 'Export status.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'message'   => array(
				'description' => __( 'Export status message.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'export_id' => array(
				'description' => __( 'Export ID.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
		),
	);

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