PHP Класс WC_REST_System_Status_Tools_Controller

Наследование: extends WC_REST_Controller
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$namespace string Endpoint namespace.
$rest_base string Route base.

Открытые методы

Метод Описание
execute_tool ( string $tool ) : array Actually executes a a tool.
get_collection_params ( ) : array Get any query params needed.
get_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Return a single tool.
get_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check whether a given request has permission to view a specific system status tool.
get_item_schema ( ) : array Get the system status tools schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Get a list of system status tools.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check whether a given request has permission to view system status tools.
get_tools ( ) : array A list of avaiable tools for use in the system status section.
prepare_item_for_response ( array $item, WP_REST_Request $request ) : WP_REST_Response Prepare a tool item for serialization.
register_routes ( ) Register the routes for /system_status/tools/*.
update_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Update (execute) a tool.
update_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check whether a given request has permission to execute a specific system status tool.

Защищенные методы

Метод Описание
prepare_links ( string $id ) : array Prepare links for the request.

Описание методов

execute_tool() публичный Метод

Actually executes a a tool.
public execute_tool ( string $tool ) : array
$tool string
Результат array

get_collection_params() публичный Метод

Get any query params needed.
public get_collection_params ( ) : array
Результат array

get_item() публичный Метод

Return a single tool.
public get_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request
Результат WP_Error | WP_REST_Response

get_item_permissions_check() публичный Метод

Check whether a given request has permission to view a specific system status tool.
public get_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean
$request WP_REST_Request Full details about the request.
Результат WP_Error | boolean

get_item_schema() публичный Метод

Get the system status tools schema, conforming to JSON Schema.
public get_item_schema ( ) : array
Результат array

get_items() публичный Метод

Get a list of system status tools.
public get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
Результат WP_Error | WP_REST_Response

get_items_permissions_check() публичный Метод

Check whether a given request has permission to view system status tools.
public get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean
$request WP_REST_Request Full details about the request.
Результат WP_Error | boolean

get_tools() публичный Метод

'button' becomes 'action' in the API.
public get_tools ( ) : array
Результат array

prepare_item_for_response() публичный Метод

Prepare a tool item for serialization.
public prepare_item_for_response ( array $item, WP_REST_Request $request ) : WP_REST_Response
$item array Object.
$request WP_REST_Request Request object.
Результат WP_REST_Response $response Response data.

register_routes() публичный Метод

Register the routes for /system_status/tools/*.
public register_routes ( )

update_item() публичный Метод

Update (execute) a tool.
public update_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request
Результат WP_Error | WP_REST_Response

update_item_permissions_check() публичный Метод

Check whether a given request has permission to execute a specific system status tool.
public update_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean
$request WP_REST_Request Full details about the request.
Результат WP_Error | boolean

Описание свойств

$namespace защищенное свойство

Endpoint namespace.
protected string $namespace
Результат string

$rest_base защищенное свойство

Route base.
protected string $rest_base
Результат string