PHP 클래스 WC_API_Webhooks

상속: extends WC_API_Resource
파일 보기 프로젝트 열기: woocommerce/woocommerce

보호된 프로퍼티들

프로퍼티 타입 설명
$base string the route base

공개 메소드들

메소드 설명
create_webhook ( array $data ) : array Create an webhook
delete_webhook ( integer $id ) : array Delete a webhook
edit_webhook ( integer $id, array $data ) : array Edit a webhook
get_webhook ( integer $id, array $fields = null ) : array Get the webhook for the given ID
get_webhook_deliveries ( string $webhook_id, string | null $fields = null ) : array Get deliveries for a webhook
get_webhook_delivery ( string $webhook_id, string $id, string | null $fields = null ) : array Get the delivery log for the given webhook ID and delivery ID
get_webhooks ( array $fields = null, array $filter = [], $status = null, integer $page = 1 ) : array Get all webhooks
get_webhooks_count ( string $status = null, array $filter = [] ) : array Get the total number of webhooks
register_routes ( array $routes ) : array Register the routes for this class

비공개 메소드들

메소드 설명
query_webhooks ( array $args ) : WP_Query Helper method to get webhook post objects

메소드 상세

create_webhook() 공개 메소드

Create an webhook
부터: 2.2
public create_webhook ( array $data ) : array
$data array parsed webhook data
리턴 array

delete_webhook() 공개 메소드

Delete a webhook
부터: 2.2
public delete_webhook ( integer $id ) : array
$id integer webhook ID
리턴 array

edit_webhook() 공개 메소드

Edit a webhook
부터: 2.2
public edit_webhook ( integer $id, array $data ) : array
$id integer webhook ID
$data array parsed webhook data
리턴 array

get_webhook() 공개 메소드

Get the webhook for the given ID
부터: 2.2
public get_webhook ( integer $id, array $fields = null ) : array
$id integer webhook ID
$fields array
리턴 array

get_webhook_deliveries() 공개 메소드

Get deliveries for a webhook
부터: 2.2
public get_webhook_deliveries ( string $webhook_id, string | null $fields = null ) : array
$webhook_id string webhook ID
$fields string | null fields to include in response
리턴 array

get_webhook_delivery() 공개 메소드

Get the delivery log for the given webhook ID and delivery ID
부터: 2.2
public get_webhook_delivery ( string $webhook_id, string $id, string | null $fields = null ) : array
$webhook_id string webhook ID
$id string delivery log ID
$fields string | null fields to limit response to
리턴 array

get_webhooks() 공개 메소드

Get all webhooks
부터: 2.2
public get_webhooks ( array $fields = null, array $filter = [], $status = null, integer $page = 1 ) : array
$fields array
$filter array
$page integer
리턴 array

get_webhooks_count() 공개 메소드

Get the total number of webhooks
부터: 2.2
public get_webhooks_count ( string $status = null, array $filter = [] ) : array
$status string
$filter array
리턴 array

register_routes() 공개 메소드

Register the routes for this class
부터: 2.2
public register_routes ( array $routes ) : array
$routes array
리턴 array

프로퍼티 상세

$base 보호되어 있는 프로퍼티

the route base
protected string $base
리턴 string