Class WC_REST_System_Status_Controller

WP_REST_Controller

Extended by

WC_REST_Controller

Extended by

WC_REST_System_Status_Controller

Package: WooCommerce\API
Author: WooThemes
Extends: WC_REST_Controller
Located at api/class-wc-rest-system-status-controller.php

Methods summary

`public`	# `register_routes( )` Register the route for /system_status Register the route for /system_status
`public WP_Error\|boolean`	# `get_items_permissions_check( WP_REST_Request $request )` Check whether a given request has permission to view system status. Check whether a given request has permission to view system status. Parameters `$request` Full details about the request. Returns WP_Error\|boolean
`public WP_Error\|WP_REST_Response`	# `get_items( WP_REST_Request $request )` Get a system status info, by section. Get a system status info, by section. Parameters `$request` Full details about the request. Returns WP_Error\|WP_REST_Response
`public array`	# `get_item_schema( )` Get the system status schema, conforming to JSON Schema. Get the system status schema, conforming to JSON Schema. Returns array
`public array`	# `get_item_mappings( )` Return an array of sections and the data associated with each. Return an array of sections and the data associated with each. Returns array
`public array`	# `get_environment_info( )` Get array of environment information. Includes thing like software versions, and various server settings. Get array of environment information. Includes thing like software versions, and various server settings. Returns array
`protected stromg`	# `add_db_table_prefix( string $table )` Add prefix to table. Add prefix to table. Parameters `$table` table name Returns stromg
`public array`	# `get_database_info( )` Get array of database information. Version, prefix, and table existence. Get array of database information. Version, prefix, and table existence. Returns array
`public array`	# `get_post_type_counts( )` Get array of counts of objects. Orders, products, etc. Get array of counts of objects. Orders, products, etc. Returns array
`public array`	# `get_active_plugins( )` Get a list of plugins active on the site. Get a list of plugins active on the site. Returns array
`public array`	# `get_theme_info( )` Get info on the current active theme, info on parent theme (if presnet) and a list of template overrides. Get info on the current active theme, info on parent theme (if presnet) and a list of template overrides. Returns array
`public array`	# `get_settings( )` Get some setting values for the site that are useful for debugging purposes. For full settings access, use the settings api. Get some setting values for the site that are useful for debugging purposes. For full settings access, use the settings api. Returns array
`public array`	# `get_security_info( )` Returns security tips. Returns security tips. Returns array
`public array`	# `get_pages( )` Returns a mini-report on WC pages and if they are configured correctly: Present, visible, and including the correct shortcode. Returns a mini-report on WC pages and if they are configured correctly: Present, visible, and including the correct shortcode. Returns array
`public array`	# `get_collection_params( )` Get any query params needed. Get any query params needed. Returns array
`public WP_REST_Response`	# `prepare_item_for_response( array $system_status, WP_REST_Request $request )` Prepare the system status response Prepare the system status response Parameters `$system_status` `$request` Request object. Returns WP_REST_Response $response Response data.

Methods inherited from WC_REST_Controller

add_additional_fields_schema(), add_meta_query(), batch_items(), check_batch_limit(), get_normalized_rest_base(), get_public_batch_schema(), validate_setting_checkbox_field(), validate_setting_image_width_field(), validate_setting_multiselect_field(), validate_setting_radio_field(), validate_setting_select_field(), validate_setting_text_field(), validate_setting_textarea_field()

Properties summary

`protected string`	`$namespace` Endpoint namespace. Endpoint namespace.	# `'wc/v2'`
`protected string`	`$rest_base` Route base. Route base.	# `'system_status'`