woocommerce_webhook_hash_algorithm

Generate a base64-encoded HMAC-SHA256 signature of the payload body so the.

Description

(string) apply_filters( 'woocommerce_webhook_hash_algorithm', (string) $sha256, (unknown) $payload, (unknown) $this_id ); 

recipient can verify the authenticity of the webhook. Note that the signature. is calculated after the body has already been encoded (JSON by default).

Returns (string)

hash

Parameters (3)

0. $sha256 (string) => 'sha256'
The sha256.
1. $payload (unknown)
The payload.
2. $this_id (unknown)
The this id.

Usage

To run the hook, copy the example below.
  1. $sha256 = apply_filters( 'woocommerce_webhook_hash_algorithm', $sha256, $payload, $this_id ); 
  2.  
  3. if ( !empty( $sha256 ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_webhook_hash_algorithm callback 
  2. function filter_woocommerce_webhook_hash_algorithm( $sha256, $payload, $this_id ) { 
  3. // make filter magic happen here... 
  4. return $sha256
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'woocommerce_webhook_hash_algorithm', 'filter_woocommerce_webhook_hash_algorithm', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'woocommerce_webhook_hash_algorithm', 'filter_woocommerce_webhook_hash_algorithm', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/class-wc-webhook.php  
  1. $hash_algo = apply_filters( 'woocommerce_webhook_hash_algorithm', 'sha256', $payload, $this->id );