PHP Класс WC_REST_Payment_Gateways_Controller

Наследование: extends WC_REST_Controller

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

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

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

Метод	Описание
get_collection_params ( ) : array	Get any query params needed.
get_gateway ( WP_REST_Request $request ) : WP_REST_Response \| null	Get a gateway based on the current request object.
get_item ( WP_REST_Request $request ) : WP_REST_Response \| WP_Error	Get a single payment gateway.
get_item_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check if a given request has access to read a payment gateway.
get_item_schema ( ) : array	Get the payment gateway schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : WP_Error \| WP_REST_Response	Get payment gateways.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check whether a given request has permission to view payment gateways.
get_settings ( $gateway )	Return settings associated with this payment gateway.
prepare_item_for_response ( WC_Payment_Gateway $gateway, WP_REST_Request $request ) : WP_REST_Response	Prepare a payment gateway for response.
register_routes ( )	Register the route for /payment_gateways and /payment_gateways/
update_item ( WP_REST_Request $request ) : WP_REST_Response \| WP_Error	Update A Single Shipping Zone Method.
update_items_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check whether a given request has permission to edit payment gateways.

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

Метод	Описание
prepare_links ( WC_Payment_Gateway $gateway, WP_REST_Request $request ) : array	Prepare links for the request.

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

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

Get any query params needed.

public get_collection_params ( ) : array
Результат	array

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

Get a gateway based on the current request object.

public get_gateway ( WP_REST_Request $request ) : WP_REST_Response \| null
$request	WP_REST_Request
Результат	WP_REST_Response \| null

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

Get a single payment gateway.

public get_item ( WP_REST_Request $request ) : WP_REST_Response \| WP_Error
$request	WP_REST_Request
Результат	WP_REST_Response \| WP_Error

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

Check if a given request has access to read a payment gateway.

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 payment gateway schema, conforming to JSON Schema.

public get_item_schema ( ) : array
Результат	array

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

Get payment gateways.

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 payment gateways.

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_settings() публичный Метод

Return settings associated with this payment gateway.

public get_settings ( $gateway )

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

Prepare a payment gateway for response.

public prepare_item_for_response ( WC_Payment_Gateway $gateway, WP_REST_Request $request ) : WP_REST_Response
$gateway	WC_Payment_Gateway	Payment gateway object.
$request	WP_REST_Request	Request object.
Результат	WP_REST_Response	$response Response data.

prepare_links() защищенный Метод

Prepare links for the request.

protected prepare_links ( WC_Payment_Gateway $gateway, WP_REST_Request $request ) : array
$gateway	WC_Payment_Gateway	Payment gateway object.
$request	WP_REST_Request	Request object.
Результат	array

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

public register_routes ( )

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

Update A Single Shipping Zone Method.

public update_item ( WP_REST_Request $request ) : WP_REST_Response \| WP_Error
$request	WP_REST_Request
Результат	WP_REST_Response \| WP_Error

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

Check whether a given request has permission to edit payment gateways.

public update_items_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