Automattic\WooCommerce\Internal\RestApi\Routes\V4\Settings\Products\Schema
ProductSettingsSchema{} │ WC 1.0└─ AbstractSchema
Product Settings Schema Class.
No Hooks.
Usage
$ProductSettingsSchema = new ProductSettingsSchema(); // use class methods
Methods
- public get_item_response( $item, WP_REST_Request $request, array $include_fields = array() )
- public get_item_schema_properties()
- private get_field_options( string $field_id )
- private get_field_schema()
- private normalize_field_type( string $wc_type )
- private transform_setting_to_field( array $setting )
- private validate_field_value( $value, string $type )
ProductSettingsSchema{} ProductSettingsSchema{} code WC 10.4.3
class ProductSettingsSchema extends AbstractSchema {
/**
* The schema item identifier.
*
* @var string
*/
const IDENTIFIER = 'product_settings';
/**
* Return all properties for the item schema.
*
* @return array The schema properties.
*/
public function get_item_schema_properties(): array {
return array(
'id' => array(
'description' => __( 'Unique identifier for the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'description' => __( 'Settings title.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'description' => __( 'Settings description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'additionalProperties' => array(
'description' => __( 'Setting field value.', 'woocommerce' ),
'type' => array( 'string', 'number', 'array', 'boolean' ),
),
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'number', 'select', 'multiselect', 'checkbox' ),
'context' => array( 'view', 'edit' ),
),
'options' => array(
'description' => __( 'Available options for select/multiselect fields.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
),
'desc' => array(
'description' => __( 'Description for the setting field.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
);
}
/**
* Get product settings data by transforming WC_Settings_Products data into REST API format.
*
* @param mixed $item Settings products instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include.
* @return array
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
$raw_settings = $item;
// Transform raw settings into grouped format based on title/sectionend markers.
$groups = array();
$values = array();
$current_group = null;
$current_group_id = null;
foreach ( $raw_settings as $setting ) {
$setting_type = $setting['type'] ?? '';
// Handle section titles - start of a new group.
if ( 'title' === $setting_type ) {
$current_group_id = $setting['id'] ?? '';
$current_group = array(
'title' => $setting['title'] ?? '',
'description' => $setting['desc'] ?? '',
'order' => isset( $setting['order'] ) ? (int) $setting['order'] : 999,
'fields' => array(),
);
continue;
}
// Handle section ends - save the current group.
if ( 'sectionend' === $setting_type ) {
if ( $current_group && $current_group_id ) {
$groups[ $current_group_id ] = $current_group;
}
$current_group = null;
$current_group_id = null;
continue;
}
// Skip title and sectionend types.
if ( in_array( $setting_type, array( 'title', 'sectionend' ), true ) ) {
continue;
}
// Convert setting to field format.
if ( isset( $setting['id'] ) && $current_group ) {
$field = $this->transform_setting_to_field( $setting );
if ( $field ) {
$current_group['fields'][] = $field;
// Add field value to the flat values array.
$raw_value = get_option( $field['id'], $setting['default'] ?? '' );
$values[ $field['id'] ] = $this->validate_field_value( $raw_value, $field['type'] );
}
}
}
// Sort groups by their order if available.
uasort(
$groups,
function ( $a, $b ) {
$a_order = $a['order'] ?? 999;
$b_order = $b['order'] ?? 999;
return $a_order - $b_order;
}
);
return array(
'id' => 'products',
'title' => __( 'Products', 'woocommerce' ),
'description' => __( 'Manage product settings including dimensions, weight units, and display options.', 'woocommerce' ),
'values' => $values,
'groups' => $groups,
);
}
/**
* Transform a WooCommerce setting into REST API field format.
*
* @param array $setting WooCommerce setting array.
* @return array|null Transformed field or null if should be skipped.
*/
private function transform_setting_to_field( array $setting ): ?array {
$setting_id = $setting['id'] ?? '';
$setting_type = $setting['type'] ?? 'text';
$field = array(
'id' => $setting_id,
'label' => $setting['title'] ?? $setting_id,
'type' => $this->normalize_field_type( $setting_type ),
'desc' => $setting['desc'] ?? '',
);
// Add options for select fields.
if ( isset( $setting['options'] ) && is_array( $setting['options'] ) ) {
$field['options'] = $setting['options'];
} else {
// Generate options for special field types.
$field['options'] = $this->get_field_options( $setting_id );
}
return $field;
}
/**
* Get options for specific field types.
*
* @param string $field_id Field ID.
* @return array Field options.
*/
private function get_field_options( string $field_id ): array {
switch ( $field_id ) {
case 'woocommerce_weight_unit':
return array(
'kg' => __( 'kg', 'woocommerce' ),
'g' => __( 'g', 'woocommerce' ),
'lbs' => __( 'lbs', 'woocommerce' ),
'oz' => __( 'oz', 'woocommerce' ),
);
case 'woocommerce_dimension_unit':
return array(
'm' => __( 'm', 'woocommerce' ),
'cm' => __( 'cm', 'woocommerce' ),
'mm' => __( 'mm', 'woocommerce' ),
'in' => __( 'in', 'woocommerce' ),
'yd' => __( 'yd', 'woocommerce' ),
);
case 'woocommerce_product_type':
if ( ! function_exists( 'wc_get_product_types' ) ) {
return array();
}
$product_types = wc_get_product_types();
return is_array( $product_types ) ? $product_types : array();
}
return array();
}
/**
* Normalize WooCommerce field types to REST API field types.
*
* @param string $wc_type WooCommerce field type.
* @return string Normalized field type.
*/
private function normalize_field_type( string $wc_type ): string {
$type_map = array(
'single_select_product' => 'select',
'multi_select_product' => 'multiselect',
);
return $type_map[ $wc_type ] ?? $wc_type;
}
/**
* Validate and sanitize field value based on its type.
*
* @param mixed $value Field value.
* @param string $type Field type.
* @return mixed Validated value.
*/
private function validate_field_value( $value, string $type ) {
switch ( $type ) {
case 'number':
return is_numeric( $value ) ? (float) $value : 0;
case 'checkbox':
if ( function_exists( 'wc_string_to_bool' ) ) {
return wc_string_to_bool( $value );
}
if ( is_bool( $value ) ) {
return $value;
}
return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
case 'multiselect':
return is_array( $value ) ? $value : array();
case 'text':
case 'select':
default:
return is_string( $value ) ? $value : (string) $value;
}
}
}