• 홈
• WC_Webhook

PHP 클래스 WC_Webhook

This class handles storing and retrieving webhook data from the associated. shop_webhook custom post type, as well as delivery logs from the webhook_delivery. comment type. Webhooks are enqueued to their associated actions, delivered, and logged. 파일 보기 프로젝트 열기: woocommerce/woocommerce 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$id		webhook ID (post ID)

공개 메소드들

메소드	설명
__construct ( string | integer $id )	Setup webhook & load post data.
__get ( string $key ) : mixed	Magic get, wraps get_post_meta() for all keys except $status.
__isset ( string $key ) : boolean	Magic isset as a wrapper around metadata_exists().
deliver ( mixed $arg )	Deliver the webhook payload using wp_safe_remote_request().
deliver_ping ( ) : boolean | WP_Error	Send a test ping to the delivery URL, sent when the webhook is first created.
enqueue ( )	Enqueue the hooks associated with the webhook.
generate_signature ( string $payload ) : string	Generate a base64-encoded HMAC-SHA256 signature of the payload body so the.
get_api_version ( ) : string	API version.
get_delivery_log ( integer $delivery_id ) : boolean | array	Get the delivery log specified by the ID. The delivery log includes:
get_delivery_logs ( ) : array	Get the delivery logs for this webhook.
get_delivery_url ( ) : string	Get the delivery URL.
get_event ( ) : string	Get the event for the webhook, e.g. created.
get_failure_count ( ) : integer	Get the failure count.
get_hooks ( ) : array	Get the hook names for the webhook.
get_i18n_status ( ) : string	Get the webhook i18n status.
get_name ( ) : string	Get the friendly name for the webhook.
get_new_delivery_id ( ) : integer	Create a new comment for log the delivery request/response and.
get_post_data ( ) : null | WP_Post	Get the post data for the webhook.
get_resource ( ) : string	Get the resource for the webhook, e.g. order.
get_secret ( ) : string	Get the secret used for generating the HMAC-SHA256 signature.
get_status ( ) : string	Get the webhook status:
get_topic ( ) : string	Get the webhook topic, e.g. order.created.
get_user_id ( ) : integer | string	Get the user ID for this webhook.
log_delivery ( integer $delivery_id, array $request, array | WP_Error $response, float $duration )	Log the delivery request/response.
process ( mixed $arg )	Process the webhook for delivery by verifying that it should be delivered.
set_api_version ( string $version )	Set API version.
set_delivery_url ( string $url )	Set the delivery URL.
set_secret ( string $secret )	Set the secret used for generating the HMAC-SHA256 signature.
set_topic ( string $topic )	Set the webhook topic and associated hooks. The topic resource & event.
update_status ( $status )	Update the webhook status, see get_status() for valid statuses.

비공개 메소드들

메소드	설명
build_payload ( mixed $resource_id ) : mixed	Build the payload data for the webhook.
failed_delivery ( )	Track consecutive delivery failures and automatically disable the webhook.
get_legacy_api_payload ( string $resource, integer $resource_id, string $event ) : array	Get Legacy API payload.
get_topic_hooks ( string $topic ) : array	Get the associated hook names for a topic.
get_wp_api_payload ( string $resource, integer $resource_id, string $event ) : array	Get WP API integration payload.
should_deliver ( mixed $arg ) : boolean	Helper to check if the webhook should be delivered, as some hooks.

메소드 상세

프로퍼티 상세