WC_REST_System_Status_Controller
extends WC_REST_System_Status_V2_Controller
in package
System status controller class.
Tags
Table of Contents
- $namespace : string
- Endpoint namespace.
- $rest_base : string
- Route base.
- $_fields : null|array<string|int, mixed>
- Used to cache computed return fields.
- $_request : null|WP_REST_Request
- Used to verify if cached fields are for correct request object.
- batch_items() : array<string|int, mixed>
- Bulk create, update and delete items.
- clean_plugin_cache() : mixed
- Clear the system status plugin caches
- clean_theme_cache() : mixed
- Clear the system status theme cache
- get_active_plugins() : array<string|int, mixed>
- Get a list of plugins active on the site.
- get_collection_params() : array<string|int, mixed>
- Get any query params needed.
- get_database_info() : array<string|int, mixed>
- Get array of database information. Version, prefix, and table existence.
- get_dropins_mu_plugins() : array<string|int, mixed>
- Get a list of Dropins and MU plugins.
- get_endpoint_args_for_item_schema() : array<string|int, mixed>
- Compatibility functions for WP 5.5, since custom types are not supported anymore.
- get_environment_info() : array<string|int, mixed>
- Get array of environment information. Includes thing like software versions, and various server settings.
- get_environment_info_per_fields() : array<string|int, mixed>
- Get array of environment information. Includes thing like software versions, and various server settings.
- get_fields_for_response() : array<string|int, mixed>
- Gets an array of fields to be included on the response.
- get_inactive_plugins() : array<string|int, mixed>
- Get a list of inactive plugins.
- get_item_mappings() : array<string|int, mixed>
- Return an array of sections and the data associated with each.
- get_item_mappings_per_fields() : array<string|int, mixed>
- Return an array of sections and the data associated with each.
- get_item_schema() : array<string|int, mixed>
- Get the system status schema, conforming to JSON Schema.
- get_items() : WP_Error|WP_REST_Response
- Get a system status info, by section.
- get_items_permissions_check() : WP_Error|bool
- Check whether a given request has permission to view system status.
- get_pages() : array<string|int, mixed>
- Returns a mini-report on WC pages and if they are configured correctly: Present, visible, and including the correct shortcode or block.
- get_post_type_counts() : array<string|int, mixed>
- Get array of counts of objects. Orders, products, etc.
- get_public_batch_schema() : array<string|int, mixed>
- Get the batch schema, conforming to JSON Schema.
- get_security_info() : array<string|int, mixed>
- Returns security tips.
- get_settings() : array<string|int, mixed>
- Get some setting values for the site that are useful for debugging purposes. For full settings access, use the settings api.
- get_theme_info() : array<string|int, mixed>
- Get info on the current active theme, info on parent theme (if presnet) and a list of template overrides.
- prepare_item_for_response() : WP_REST_Response
- Prepare the system status response
- register_cache_clean() : mixed
- Register cache cleaner
- register_routes() : mixed
- Register the route for /system_status
- 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<string|int, mixed>|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<string|int, mixed>
- Add the schema from additional fields to an schema array.
- add_db_table_prefix() : stromg
- Add prefix to table.
- add_meta_query() : array<string|int, mixed>
- 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.
- format_plugin_data() : array<string|int, mixed>
- Format plugin data, including data on updates, into a standard format.
- get_logging_info() : array<string|int, mixed>
- Get info about the logging system.
- get_meta_data_for_response() : array<string|int, mixed>
- Limit the contents of the meta_data property based on certain request parameters.
- get_normalized_rest_base() : string
- Get normalized rest base.
- check_if_field_item_exists() : bool
- Check if field item exists.
Properties
$namespace
Endpoint namespace.
protected
string
$namespace
= 'wc/v3'
$rest_base
Route base.
protected
string
$rest_base
= ''
$_fields
Used to cache computed return fields.
private
null|array<string|int, mixed>
$_fields
=
ull
$_request
Used to verify if cached fields are for correct request object.
private
null|WP_REST_Request
$_request
=
ull
Methods
batch_items()
Bulk create, update and delete items.
public
batch_items(WP_REST_Request $request) : array<string|int, mixed>
Parameters
- $request : WP_REST_Request
-
Full details about the request.
Return values
array<string|int, mixed> — Of WP_Error or WP_REST_Response.clean_plugin_cache()
Clear the system status plugin caches
public
static clean_plugin_cache() : mixed
Return values
mixed —clean_theme_cache()
Clear the system status theme cache
public
static clean_theme_cache() : mixed
Return values
mixed —get_active_plugins()
Get a list of plugins active on the site.
public
get_active_plugins() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_collection_params()
Get any query params needed.
public
get_collection_params() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_database_info()
Get array of database information. Version, prefix, and table existence.
public
get_database_info() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_dropins_mu_plugins()
Get a list of Dropins and MU plugins.
public
get_dropins_mu_plugins() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_endpoint_args_for_item_schema()
Compatibility functions for WP 5.5, since custom types are not supported anymore.
public
get_endpoint_args_for_item_schema([string $method = WP_REST_Server::CREATABLE ]) : array<string|int, mixed>
See @link https://core.trac.wordpress.org/changeset/48306
Parameters
- $method : string = WP_REST_Server::CREATABLE
-
Optional. HTTP method of the request.
Return values
array<string|int, mixed> — Endpoint arguments.get_environment_info()
Get array of environment information. Includes thing like software versions, and various server settings.
public
get_environment_info() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_environment_info_per_fields()
Get array of environment information. Includes thing like software versions, and various server settings.
public
get_environment_info_per_fields(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
- $fields : array<string|int, mixed>
-
List of fields to be included on the response.
Return values
array<string|int, mixed> —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<string|int, mixed>
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
Return values
array<string|int, mixed> — Fields to be included in the response.get_inactive_plugins()
Get a list of inactive plugins.
public
get_inactive_plugins() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_item_mappings()
Return an array of sections and the data associated with each.
public
get_item_mappings() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_item_mappings_per_fields()
Return an array of sections and the data associated with each.
public
get_item_mappings_per_fields(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
- $fields : array<string|int, mixed>
-
List of fields to be included on the response.
Tags
Return values
array<string|int, mixed> —get_item_schema()
Get the system status schema, conforming to JSON Schema.
public
get_item_schema() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_items()
Get a system status info, by section.
public
get_items(WP_REST_Request $request) : WP_Error|WP_REST_Response
Parameters
- $request : WP_REST_Request
-
Full details about the request.
Return values
WP_Error|WP_REST_Response —get_items_permissions_check()
Check whether a given request has permission to view system status.
public
get_items_permissions_check(WP_REST_Request $request) : WP_Error|bool
Parameters
- $request : WP_REST_Request
-
Full details about the request.
Return values
WP_Error|bool —get_pages()
Returns a mini-report on WC pages and if they are configured correctly: Present, visible, and including the correct shortcode or block.
public
get_pages() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_post_type_counts()
Get array of counts of objects. Orders, products, etc.
public
get_post_type_counts() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_public_batch_schema()
Get the batch schema, conforming to JSON Schema.
public
get_public_batch_schema() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_security_info()
Returns security tips.
public
get_security_info() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_settings()
Get some setting values for the site that are useful for debugging purposes. For full settings access, use the settings api.
public
get_settings() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_theme_info()
Get info on the current active theme, info on parent theme (if presnet) and a list of template overrides.
public
get_theme_info() : array<string|int, mixed>
Return values
array<string|int, mixed> —prepare_item_for_response()
Prepare the system status response
public
prepare_item_for_response(array<string|int, mixed> $system_status, WP_REST_Request $request) : WP_REST_Response
Parameters
- $system_status : array<string|int, mixed>
-
System status data.
- $request : WP_REST_Request
-
Request object.
Return values
WP_REST_Response —register_cache_clean()
Register cache cleaner
public
static register_cache_clean() : mixed
Handles all the cache cleaning for this endpoint. We need to register these functions before the routes are registered, so this function gets called from Server.php
Return values
mixed —register_routes()
Register the route for /system_status
public
register_routes() : mixed
Return values
mixed —validate_setting_checkbox_field()
Validate checkbox based settings.
public
validate_setting_checkbox_field(string $value, array<string|int, mixed> $setting) : string|WP_Error
Parameters
- $value : string
-
Value.
- $setting : array<string|int, mixed>
-
Setting.
Tags
Return values
string|WP_Error —validate_setting_image_width_field()
Validate image_width based settings.
public
validate_setting_image_width_field(array<string|int, mixed> $values, array<string|int, mixed> $setting) : string|WP_Error
Parameters
- $values : array<string|int, mixed>
-
Values.
- $setting : array<string|int, mixed>
-
Setting.
Tags
Return values
string|WP_Error —validate_setting_multiselect_field()
Validate multiselect based settings.
public
validate_setting_multiselect_field(array<string|int, mixed> $values, array<string|int, mixed> $setting) : array<string|int, mixed>|WP_Error
Parameters
- $values : array<string|int, mixed>
-
Values.
- $setting : array<string|int, mixed>
-
Setting.
Tags
Return values
array<string|int, mixed>|WP_Error —validate_setting_radio_field()
Validate radio based settings.
public
validate_setting_radio_field(string $value, array<string|int, mixed> $setting) : string|WP_Error
Parameters
- $value : string
-
Value.
- $setting : array<string|int, mixed>
-
Setting.
Tags
Return values
string|WP_Error —validate_setting_select_field()
Validate select based settings.
public
validate_setting_select_field(string $value, array<string|int, mixed> $setting) : string|WP_Error
Parameters
- $value : string
-
Value.
- $setting : array<string|int, mixed>
-
Setting.
Tags
Return values
string|WP_Error —validate_setting_text_field()
Validate a text value for a text based setting.
public
validate_setting_text_field(string $value, array<string|int, mixed> $setting) : string
Parameters
- $value : string
-
Value.
- $setting : array<string|int, mixed>
-
Setting.
Tags
Return values
string —validate_setting_textarea_field()
Validate textarea based settings.
public
validate_setting_textarea_field(string $value, array<string|int, mixed> $setting) : string
Parameters
- $value : string
-
Value.
- $setting : array<string|int, mixed>
-
Setting.
Tags
Return values
string —add_additional_fields_schema()
Add the schema from additional fields to an schema array.
protected
add_additional_fields_schema(array<string|int, mixed> $schema) : array<string|int, mixed>
The type of object is inferred from the passed schema.
Parameters
- $schema : array<string|int, mixed>
-
Schema array.
Return values
array<string|int, mixed> —add_db_table_prefix()
Add prefix to table.
protected
add_db_table_prefix(string $table) : stromg
Parameters
- $table : string
-
Table name.
Return values
stromg —add_meta_query()
Add meta query.
protected
add_meta_query(array<string|int, mixed> $args, array<string|int, mixed> $meta_query) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
-
Query args.
- $meta_query : array<string|int, mixed>
-
Meta query.
Tags
Return values
array<string|int, mixed> —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<string|int, mixed> $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<string|int, mixed>
-
Schema with datatypes to convert.
Return values
mixed — Schema with converted datatype.check_batch_limit()
Check batch limit.
protected
check_batch_limit(array<string|int, mixed> $items) : bool|WP_Error
Parameters
- $items : array<string|int, mixed>
-
Request items.
Return values
bool|WP_Error —format_plugin_data()
Format plugin data, including data on updates, into a standard format.
protected
format_plugin_data(string $plugin, array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $plugin : string
-
Plugin directory/file.
- $data : array<string|int, mixed>
-
Plugin data from WP.
Tags
Return values
array<string|int, mixed> — Formatted data.get_logging_info()
Get info about the logging system.
protected
get_logging_info() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_meta_data_for_response()
Limit the contents of the meta_data property based on certain request parameters.
protected
get_meta_data_for_response(WP_REST_Request $request, array<string|int, mixed> $meta_data) : array<string|int, mixed>
Note that if both include_meta and exclude_meta are present in the request,
include_meta will take precedence.
Parameters
- $request : WP_REST_Request
-
The request.
- $meta_data : array<string|int, mixed>
-
All of the meta data for an object.
Return values
array<string|int, mixed> —get_normalized_rest_base()
Get normalized rest base.
protected
get_normalized_rest_base() : string
Return values
string —check_if_field_item_exists()
Check if field item exists.
private
check_if_field_item_exists(string $section, array<string|int, mixed> $items, array<string|int, mixed> $fields) : bool
Parameters
- $section : string
-
Fields section.
- $items : array<string|int, mixed>
-
List of items to check for.
- $fields : array<string|int, mixed>
-
List of fields to be included on the response.