WooCommerce Code Reference

WC_REST_Report_Reviews_Totals_Controller extends WC_REST_Reports_Controller

REST API Reports Reviews Totals controller class.

Tags
extends

WC_REST_Reports_Controller

Table of Contents

$namespace  : string
Endpoint namespace.
$rest_base  : string
Route base.
batch_items()  : array
Bulk create, update and delete items.
get_collection_params()  : array
Get the query params for collections.
get_endpoint_args_for_item_schema()  : array
Compatibility functions for WP 5.5, since custom types are not supported anymore.
get_fields_for_response()  : array
Gets an array of fields to be included on the response.
get_item_schema()  : array
Get the Report's schema, conforming to JSON Schema.
get_items()  : array|WP_Error
Get all reports.
get_items_permissions_check()  : WP_Error|bool
Check whether a given request has permission to read reports.
get_public_batch_schema()  : array
Get the batch schema, conforming to JSON Schema.
prepare_item_for_response()  : WP_REST_Response
Prepare a report object for serialization.
register_routes()  : mixed
Register the routes for reports.
validate_setting_checkbox_field()  : string|WP_Error
Validate checkbox based settings.
validate_setting_image_width_field()  : string|WP_Error
Validate image_width based settings.
validate_setting_multiselect_field()  : array|WP_Error
Validate multiselect based settings.
validate_setting_radio_field()  : string|WP_Error
Validate radio based settings.
validate_setting_select_field()  : string|WP_Error
Validate select based settings.
validate_setting_text_field()  : string
Validate a text value for a text based setting.
validate_setting_textarea_field()  : string
Validate textarea based settings.
add_additional_fields_schema()  : array
Add the schema from additional fields to an schema array.
add_meta_query()  : array
Add meta query.
adjust_wp_5_5_datatype_compatibility()  : mixed
Change datatypes `date-time` to string, and `mixed` to composite of all built in types. This is required for maintaining forward compatibility with WP 5.5 since custom post types are not supported anymore.
check_batch_limit()  : bool|WP_Error
Check batch limit.
get_normalized_rest_base()  : string
Get normalized rest base.
get_reports()  : array
Get reports list.

Properties

Methods

get_fields_for_response()

Gets an array of fields to be included on the response.

public get_fields_for_response(WP_REST_Request $request) : array

Included fields are based on item schema and _fields= request argument. Updated from WordPress 5.3, included into this class to support old versions.

Parameters
$request : WP_REST_Request

Full details about the request.

Tags
since
3.5.0
Return values
arrayFields to be included in the response.

validate_setting_checkbox_field()

Validate checkbox based settings.

public validate_setting_checkbox_field(string $value, array $setting) : string|WP_Error
Parameters
$value : string

Value.

$setting : array

Setting.

Tags
since
3.0.0
Return values
string|WP_Error

validate_setting_image_width_field()

Validate image_width based settings.

public validate_setting_image_width_field(array $values, array $setting) : string|WP_Error
Parameters
$values : array

Values.

$setting : array

Setting.

Tags
since
3.0.0
Return values
string|WP_Error

validate_setting_multiselect_field()

Validate multiselect based settings.

public validate_setting_multiselect_field(array $values, array $setting) : array|WP_Error
Parameters
$values : array

Values.

$setting : array

Setting.

Tags
since
3.0.0
Return values
array|WP_Error

add_additional_fields_schema()

Add the schema from additional fields to an schema array.

protected add_additional_fields_schema(array $schema) : array

The type of object is inferred from the passed schema.

Parameters
$schema : array

Schema array.

Return values
array

adjust_wp_5_5_datatype_compatibility()

Change datatypes `date-time` to string, and `mixed` to composite of all built in types. This is required for maintaining forward compatibility with WP 5.5 since custom post types are not supported anymore.

protected adjust_wp_5_5_datatype_compatibility(array $endpoint_args) : mixed

See @link https://core.trac.wordpress.org/changeset/48306

We still use the 'mixed' type, since if we convert to composite type everywhere, it won't work in 5.4 anymore because they require to define the full schema.

Parameters
$endpoint_args : array

Schema with datatypes to convert.

Return values
mixedSchema with converted datatype.