deliver_ping() public method

Send a test ping to the delivery URL, sent when the webhook is first created.
Since: 2.2
public deliver_ping ( ) : boolean | WP_Error
return boolean | WP_Error
 /**
  * Create an webhook
  *
  * @since 2.2
  * @param array $data parsed webhook data
  * @return array
  */
 public function create_webhook($data)
 {
     $data = isset($data['webhook']) ? $data['webhook'] : array();
     try {
         // permission check
         if (!current_user_can('publish_shop_webhooks')) {
             throw new WC_API_Exception('woocommerce_api_user_cannot_create_webhooks', __('You do not have permission to create webhooks', 'woocommerce'), 401);
         }
         $data = apply_filters('woocommerce_api_create_webhook_data', $data, $this);
         // validate topic
         if (empty($data['topic']) || !wc_is_webhook_valid_topic(strtolower($data['topic']))) {
             throw new WC_API_Exception('woocommerce_api_invalid_webhook_topic', __('Webhook topic is required and must be valid', 'woocommerce'), 400);
         }
         // validate delivery URL
         if (empty($data['delivery_url']) || !wc_is_valid_url($data['delivery_url'])) {
             throw new WC_API_Exception('woocommerce_api_invalid_webhook_delivery_url', __('Webhook delivery URL must be a valid URL starting with http:// or https://', 'woocommerce'), 400);
         }
         $webhook_data = apply_filters('woocommerce_new_webhook_data', array('post_type' => 'shop_webhook', 'post_status' => 'publish', 'ping_status' => 'closed', 'post_author' => get_current_user_id(), 'post_password' => strlen($password = uniqid('webhook_')) > 20 ? substr($password, 0, 20) : $password, 'post_title' => !empty($data['name']) ? $data['name'] : sprintf(__('Webhook created on %s', 'woocommerce'), strftime(_x('%b %d, %Y @ %I:%M %p', 'Webhook created on date parsed by strftime', 'woocommerce')))), $data, $this);
         $webhook_id = wp_insert_post($webhook_data);
         if (is_wp_error($webhook_id) || !$webhook_id) {
             throw new WC_API_Exception('woocommerce_api_cannot_create_webhook', sprintf(__('Cannot create webhook: %s', 'woocommerce'), is_wp_error($webhook_id) ? implode(', ', $webhook_id->get_error_messages()) : '0'), 500);
         }
         $webhook = new WC_Webhook($webhook_id);
         // set topic, delivery URL, and optional secret
         $webhook->set_topic($data['topic']);
         $webhook->set_delivery_url($data['delivery_url']);
         // set secret if provided, defaults to API users consumer secret
         $webhook->set_secret(!empty($data['secret']) ? $data['secret'] : get_user_meta(get_current_user_id(), 'woocommerce_api_consumer_secret', true));
         // send ping
         $webhook->deliver_ping();
         // HTTP 201 Created
         $this->server->send_status(201);
         do_action('woocommerce_api_create_webhook', $webhook->id, $this);
         delete_transient('woocommerce_webhook_ids');
         return $this->get_webhook($webhook->id);
     } catch (WC_API_Exception $e) {
         return new WP_Error($e->getErrorCode(), $e->getMessage(), array('status' => $e->getCode()));
     }
 }
 /**
  * Create a single webhook.
  *
  * @param WP_REST_Request $request Full details about the request.
  * @return WP_Error|WP_REST_Response
  */
 public function create_item($request)
 {
     if (!empty($request['id'])) {
         return new WP_Error("woocommerce_rest_{$this->post_type}_exists", sprintf(__('Cannot create existing %s.', 'woocommerce'), $this->post_type), array('status' => 400));
     }
     // Validate topic.
     if (empty($request['topic']) || !wc_is_webhook_valid_topic(strtolower($request['topic']))) {
         return new WP_Error("woocommerce_rest_{$this->post_type}_invalid_topic", __('Webhook topic is required and must be valid.', 'woocommerce'), array('status' => 400));
     }
     // Validate delivery URL.
     if (empty($request['delivery_url']) || !wc_is_valid_url($request['delivery_url'])) {
         return new WP_Error("woocommerce_rest_{$this->post_type}_invalid_delivery_url", __('Webhook delivery URL must be a valid URL starting with http:// or https://.', 'woocommerce'), array('status' => 400));
     }
     $post = $this->prepare_item_for_database($request);
     if (is_wp_error($post)) {
         return $post;
     }
     $post->post_type = $this->post_type;
     $post_id = wp_insert_post($post, true);
     if (is_wp_error($post_id)) {
         if (in_array($post_id->get_error_code(), array('db_insert_error'))) {
             $post_id->add_data(array('status' => 500));
         } else {
             $post_id->add_data(array('status' => 400));
         }
         return $post_id;
     }
     $post->ID = $post_id;
     $webhook = new WC_Webhook($post_id);
     // Set topic.
     $webhook->set_topic($request['topic']);
     // Set delivery URL.
     $webhook->set_delivery_url($request['delivery_url']);
     // Set secret.
     $webhook->set_secret(!empty($request['secret']) ? $request['secret'] : '');
     // Set status.
     if (!empty($request['status'])) {
         $webhook->update_status($request['status']);
     }
     $post = get_post($post_id);
     $this->update_additional_fields_for_object($post, $request);
     /**
      * Fires after a single item is created or updated via the REST API.
      *
      * @param WP_Post         $post      Inserted object.
      * @param WP_REST_Request $request   Request object.
      * @param boolean         $creating  True when creating item, false when updating.
      */
     do_action("woocommerce_rest_insert_{$this->post_type}", $post, $request, true);
     $request->set_param('context', 'edit');
     $response = $this->prepare_item_for_response($post, $request);
     $response = rest_ensure_response($response);
     $response->set_status(201);
     $response->header('Location', rest_url(sprintf('/%s/%s/%d', $this->namespace, $this->rest_base, $post_id)));
     // Send ping.
     $webhook->deliver_ping();
     // Clear cache.
     delete_transient('woocommerce_webhook_ids');
     return $response;
 }