PHP Class WC_REST_System_Status_Controller

Inheritance: extends WC_REST_Controller
Show file Open project: woocommerce/woocommerce Class Usage Examples

Protected Properties

Property Type Description
$namespace string Endpoint namespace.
$rest_base string Route base.

Public Methods

Method Description
get_active_plugins ( ) : array Get a list of plugins active on the site.
get_collection_params ( ) : array Get any query params needed.
get_database_info ( ) : array Get array of database information. Version, prefix, and table existence.
get_environment_info ( ) : array Get array of environment information. Includes thing like software versions, and various server settings.
get_item_mappings ( ) : array Return an array of sections and the data associated with each.
get_item_schema ( ) : array Get the system status schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Get a system status info, by section.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check whether a given request has permission to view system status.
get_pages ( ) : array Returns a mini-report on WC pages and if they are configured correctly: Present, visible, and including the correct shortcode.
get_security_info ( ) : array Returns security tips.
get_settings ( ) : array 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 Get info on the current active theme, info on parent theme (if presnet) and a list of template overrides.
register_routes ( ) Register the route for /system_status

Method Details

get_active_plugins() public method

Get a list of plugins active on the site.
public get_active_plugins ( ) : array
return array

get_collection_params() public method

Get any query params needed.
public get_collection_params ( ) : array
return array

get_database_info() public method

Get array of database information. Version, prefix, and table existence.
public get_database_info ( ) : array
return array

get_environment_info() public method

Get array of environment information. Includes thing like software versions, and various server settings.
public get_environment_info ( ) : array
return array

get_item_mappings() public method

Return an array of sections and the data associated with each.
public get_item_mappings ( ) : array
return array

get_item_schema() public method

Get the system status schema, conforming to JSON Schema.
public get_item_schema ( ) : array
return array

get_items() public method

Get a system status info, by section.
public get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
return WP_Error | WP_REST_Response

get_items_permissions_check() public method

Check whether a given request has permission to view system status.
public get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean
$request WP_REST_Request Full details about the request.
return WP_Error | boolean

get_pages() public method

Returns a mini-report on WC pages and if they are configured correctly: Present, visible, and including the correct shortcode.
public get_pages ( ) : array
return array

get_security_info() public method

Returns security tips.
public get_security_info ( ) : array
return array

get_settings() public method

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
return array

get_theme_info() public method

Get info on the current active theme, info on parent theme (if presnet) and a list of template overrides.
public get_theme_info ( ) : array
return array

register_routes() public method

Register the route for /system_status
public register_routes ( )

Property Details

$namespace protected property

Endpoint namespace.
protected string $namespace
return string

$rest_base protected property

Route base.
protected string $rest_base
return string