WC_REST_General_Settings_V4_Controller
extends WC_REST_V4_Controller
in package
REST API General Settings controller class.
Tags
Table of Contents
- $namespace : string
- Endpoint namespace.
- $rest_base : string
- Route base.
- $settings_general_instance : WC_Settings_General
- WC_Settings_General instance.
- get_item() : WP_REST_Response|WP_Error
- Get general settings.
- get_item_permissions_check() : bool|WP_Error
- Check permissions for reading general settings.
- get_item_schema() : array<string|int, mixed>
- Get the schema for general settings, conforming to JSON Schema.
- prepare_response_for_collection() : array<string|int, mixed>
- Prepare a response for inserting into a collection.
- register_routes() : mixed
- Register routes.
- update_item() : WP_REST_Response|WP_Error
- Update general settings.
- update_item_permissions_check() : bool|WP_Error
- Check permissions for updating general settings.
- check_permissions() : bool|WP_Error
- Check permissions for a given request.
- get_api_version() : string
- Get the default REST API version.
- get_base_schema() : array<string|int, mixed>
- Get the base schema for the API.
- get_country_state_options() : array<string|int, mixed>
- Get country/state options for single select country field.
- get_currency_options() : array<string|int, mixed>
- Get currency options.
- get_field_options() : array<string|int, mixed>
- Get options for specific field types.
- get_field_schema() : array<string|int, mixed>
- Get the schema for individual setting fields.
- get_general_settings_data() : array<string|int, mixed>
- Get general settings data by transforming WC_Settings_General data into REST API format.
- get_group_order() : int
- Get the display order for a settings group.
- get_settings_general_instance() : WC_Settings_General
- Get the WC_Settings_General instance.
- get_update_args() : array<string|int, mixed>
- Get update arguments for the endpoint.
- normalize_field_type() : string
- Normalize WooCommerce field types to REST API field types.
- sanitize_setting_value() : mixed
- Sanitize setting value based on its type.
- transform_setting_to_field() : array<string|int, mixed>|null
- Transform a WooCommerce setting into REST API field format.
- validate_country_or_state_code() : bool
- Validate country or state code.
- validate_setting_value() : bool|WP_Error
- Validate a setting value before updating.
Properties
$namespace
Endpoint namespace.
protected
string
$namespace
= 'wc/v4'
$rest_base
Route base.
protected
string
$rest_base
= 'settings/general'
$settings_general_instance
WC_Settings_General instance.
protected
WC_Settings_General
$settings_general_instance
Methods
get_item()
Get general settings.
public
get_item(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
-
Full details about the request.
Return values
WP_REST_Response|WP_Error —get_item_permissions_check()
Check permissions for reading general settings.
public
get_item_permissions_check(WP_REST_Request $request) : bool|WP_Error
Parameters
- $request : WP_REST_Request
-
Full details about the request.
Return values
bool|WP_Error —get_item_schema()
Get the schema for general settings, conforming to JSON Schema.
public
get_item_schema() : array<string|int, mixed>
Return values
array<string|int, mixed> —prepare_response_for_collection()
Prepare a response for inserting into a collection.
public
prepare_response_for_collection(WP_REST_Response $response) : array<string|int, mixed>
Parameters
- $response : WP_REST_Response
-
Response object.
Return values
array<string|int, mixed> — Response data.register_routes()
Register routes.
public
register_routes() : mixed
Return values
mixed —update_item()
Update general settings.
public
update_item(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
-
Full details about the request.
Return values
WP_REST_Response|WP_Error —update_item_permissions_check()
Check permissions for updating general settings.
public
update_item_permissions_check(WP_REST_Request $request) : bool|WP_Error
Parameters
- $request : WP_REST_Request
-
Full details about the request.
Return values
bool|WP_Error —check_permissions()
Check permissions for a given request.
protected
check_permissions(WP_REST_Request $request[, string $permission = 'read' ]) : bool|WP_Error
Parameters
- $request : WP_REST_Request
-
Full details about the request.
- $permission : string = 'read'
-
The permission to check for.
Return values
bool|WP_Error —get_api_version()
Get the default REST API version.
protected
get_api_version() : string
Return values
string —get_base_schema()
Get the base schema for the API.
protected
get_base_schema() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_country_state_options()
Get country/state options for single select country field.
private
get_country_state_options() : array<string|int, mixed>
Return values
array<string|int, mixed> — Country/state options.get_currency_options()
Get currency options.
private
get_currency_options() : array<string|int, mixed>
Return values
array<string|int, mixed> — Currency options.get_field_options()
Get options for specific field types.
private
get_field_options(string $field_type, string $field_id) : array<string|int, mixed>
Parameters
- $field_type : string
-
Field type.
- $field_id : string
-
Field ID.
Return values
array<string|int, mixed> — Field options.get_field_schema()
Get the schema for individual setting fields.
private
get_field_schema() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_general_settings_data()
Get general settings data by transforming WC_Settings_General data into REST API format.
private
get_general_settings_data() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_group_order()
Get the display order for a settings group.
private
get_group_order(array<string|int, mixed> $setting) : int
Parameters
- $setting : array<string|int, mixed>
-
Setting definition array.
Return values
int — Display order.get_settings_general_instance()
Get the WC_Settings_General instance.
private
get_settings_general_instance() : WC_Settings_General
Return values
WC_Settings_General —get_update_args()
Get update arguments for the endpoint.
private
get_update_args() : array<string|int, mixed>
Return values
array<string|int, mixed> —normalize_field_type()
Normalize WooCommerce field types to REST API field types.
private
normalize_field_type(string $wc_type) : string
Parameters
- $wc_type : string
-
WooCommerce field type.
Return values
string — Normalized field type.sanitize_setting_value()
Sanitize setting value based on its type.
private
sanitize_setting_value(string $setting_type, mixed $value) : mixed
Parameters
- $setting_type : string
-
Setting type.
- $value : mixed
-
Setting value.
Return values
mixed — Sanitized value.transform_setting_to_field()
Transform a WooCommerce setting into REST API field format.
private
transform_setting_to_field(array<string|int, mixed> $setting) : array<string|int, mixed>|null
Parameters
- $setting : array<string|int, mixed>
-
WooCommerce setting array.
Return values
array<string|int, mixed>|null — Transformed field or null if should be skipped.validate_country_or_state_code()
Validate country or state code.
private
validate_country_or_state_code(string $country_or_state) : bool
Parameters
- $country_or_state : string
-
Country or state code.
Return values
bool — Valid or not valid.validate_setting_value()
Validate a setting value before updating.
private
validate_setting_value(string $setting_id, mixed $value) : bool|WP_Error
Parameters
- $setting_id : string
-
Setting ID.
- $value : mixed
-
Setting value.