Automattic\WooCommerce\StoreApi\Schemas\V1

ProductCollectionDataSchema::get_properties │ public │ WC 1.0

Product collection data schema properties.

Method of the class: ProductCollectionDataSchema{}

No Hooks.

Returns

Array.

Usage

$ProductCollectionDataSchema = new ProductCollectionDataSchema();
$ProductCollectionDataSchema->get_properties();

ProductCollectionDataSchema::get_properties() ProductCollectionDataSchema::get properties code ^{WC 10.8.1}

public function get_properties() {
	return [
		'price_range'         => [
			'description' => __( 'Min and max prices found in collection of products, provided using the smallest unit of the currency.', 'woocommerce' ),
			'type'        => [ 'object', 'null' ],
			'context'     => [ 'view', 'edit' ],
			'readonly'    => true,
			'properties'  => array_merge(
				$this->get_store_currency_properties(),
				[
					'min_price' => [
						'description' => __( 'Min price found in collection of products.', 'woocommerce' ),
						'type'        => 'string',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
					'max_price' => [
						'description' => __( 'Max price found in collection of products.', 'woocommerce' ),
						'type'        => 'string',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
				]
			),
		],
		'attribute_counts'    => [
			'description' => __( 'Returns number of products within attribute terms.', 'woocommerce' ),
			'type'        => [ 'array', 'null' ],
			'context'     => [ 'view', 'edit' ],
			'readonly'    => true,
			'items'       => [
				'type'       => 'object',
				'properties' => [
					'term'  => [
						'description' => __( 'Term ID', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
					'count' => [
						'description' => __( 'Number of products.', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
				],
			],
		],
		'rating_counts'       => [
			'description' => __( 'Returns number of products with each average rating.', 'woocommerce' ),
			'type'        => [ 'array', 'null' ],
			'context'     => [ 'view', 'edit' ],
			'readonly'    => true,
			'items'       => [
				'type'       => 'object',
				'properties' => [
					'rating' => [
						'description' => __( 'Average rating', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
					'count'  => [
						'description' => __( 'Number of products.', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
				],
			],
		],
		'stock_status_counts' => [
			'description' => __( 'Returns number of products with each stock status.', 'woocommerce' ),
			'type'        => [ 'array', 'null' ],
			'context'     => [ 'view', 'edit' ],
			'readonly'    => true,
			'items'       => [
				'type'       => 'object',
				'properties' => [
					'status' => [
						'description' => __( 'Status', 'woocommerce' ),
						'type'        => 'string',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
					'count'  => [
						'description' => __( 'Number of products.', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
				],
			],
		],
		'taxonomy_counts'     => [
			'description' => __( 'Returns number of products within taxonomy terms.', 'woocommerce' ),
			'type'        => [ 'array', 'null' ],
			'context'     => [ 'view', 'edit' ],
			'readonly'    => true,
			'items'       => [
				'type'       => 'object',
				'properties' => [
					'term'  => [
						'description' => __( 'Term ID', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
					'count' => [
						'description' => __( 'Number of products.', 'woocommerce' ),
						'type'        => 'integer',
						'context'     => [ 'view', 'edit' ],
						'readonly'    => true,
					],
				],
			],
		],
	];
}