class-wc-admin-webhooks.php
<?php
/**
* WooCommerce Admin Webhooks Class
*
* @package WooCommerce\Admin
* @version 3.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* WC_Admin_Webhooks.
*/
class WC_Admin_Webhooks {
/**
* Initialize the webhooks admin actions.
*/
public function __construct() {
add_action( 'admin_init', array( $this, 'actions' ) );
add_action( 'woocommerce_settings_page_init', array( $this, 'screen_option' ) );
add_filter( 'woocommerce_save_settings_advanced_webhooks', array( $this, 'allow_save_settings' ) );
}
/**
* Check if should allow save settings.
* This prevents "Your settings have been saved." notices on the table list.
*
* @param bool $allow If allow save settings.
* @return bool
*/
public function allow_save_settings( $allow ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! isset( $_GET['edit-webhook'] ) ) {
return false;
}
return $allow;
}
/**
* Check if is webhook settings page.
*
* @return bool
*/
private function is_webhook_settings_page() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
return isset( $_GET['page'], $_GET['tab'], $_GET['section'] ) && 'wc-settings' === $_GET['page'] && 'advanced' === $_GET['tab'] && 'webhooks' === $_GET['section'];
}
/**
* Save method.
*/
private function save() {
check_admin_referer( 'woocommerce-settings' );
if ( ! current_user_can( 'manage_woocommerce' ) ) {
wp_die( esc_html__( 'You do not have permission to update Webhooks', 'woocommerce' ) );
}
$errors = array();
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$webhook_id = isset( $_POST['webhook_id'] ) ? absint( $_POST['webhook_id'] ) : 0;
$webhook = new WC_Webhook( $webhook_id );
// Name.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! empty( $_POST['webhook_name'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$name = sanitize_text_field( wp_unslash( $_POST['webhook_name'] ) );
} else {
$name = sprintf(
/* translators: %s: date */
__( 'Webhook created on %s', 'woocommerce' ),
// @codingStandardsIgnoreStart
(new DateTime('now'))->format( _x( 'M d, Y @ h:i A', 'Webhook created on date parsed by DateTime::format', 'woocommerce' ) )
// @codingStandardsIgnoreEnd
);
}
$webhook->set_name( $name );
if ( ! $webhook->get_user_id() ) {
$webhook->set_user_id( get_current_user_id() );
}
// Status.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$webhook->set_status( ! empty( $_POST['webhook_status'] ) ? sanitize_text_field( wp_unslash( $_POST['webhook_status'] ) ) : 'disabled' );
// Delivery URL.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$delivery_url = ! empty( $_POST['webhook_delivery_url'] ) ? esc_url_raw( wp_unslash( $_POST['webhook_delivery_url'] ) ) : '';
if ( wc_is_valid_url( $delivery_url ) ) {
$webhook->set_delivery_url( $delivery_url );
}
// Secret.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$secret = ! empty( $_POST['webhook_secret'] ) ? sanitize_text_field( wp_unslash( $_POST['webhook_secret'] ) ) : wp_generate_password( 50, true, true );
$webhook->set_secret( $secret );
// Topic.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! empty( $_POST['webhook_topic'] ) ) {
$resource = '';
$event = '';
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
switch ( $_POST['webhook_topic'] ) {
case 'action':
$resource = 'action';
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$event = ! empty( $_POST['webhook_action_event'] ) ? sanitize_text_field( wp_unslash( $_POST['webhook_action_event'] ) ) : '';
break;
default:
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
list( $resource, $event ) = explode( '.', sanitize_text_field( wp_unslash( $_POST['webhook_topic'] ) ) );
break;
}
$topic = $resource . '.' . $event;
if ( wc_is_webhook_valid_topic( $topic ) ) {
$webhook->set_topic( $topic );
} else {
$errors[] = __( 'Webhook topic unknown. Please select a valid topic.', 'woocommerce' );
}
}
// API version.
$rest_api_versions = wc_get_webhook_rest_api_versions();
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$webhook->set_api_version( ! empty( $_POST['webhook_api_version'] ) ? sanitize_text_field( wp_unslash( $_POST['webhook_api_version'] ) ) : end( $rest_api_versions ) );
$webhook->save();
// Run actions.
do_action( 'woocommerce_webhook_options_save', $webhook->get_id() );
if ( $errors ) {
// Redirect to webhook edit page to avoid settings save actions.
wp_safe_redirect( admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=webhooks&edit-webhook=' . $webhook->get_id() . '&error=' . rawurlencode( implode( '|', $errors ) ) ) );
exit();
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
} elseif ( isset( $_POST['webhook_status'] ) && 'active' === $_POST['webhook_status'] && $webhook->get_pending_delivery() ) {
// Ping the webhook at the first time that is activated.
$result = $webhook->deliver_ping();
if ( is_wp_error( $result ) ) {
// Redirect to webhook edit page to avoid settings save actions.
wp_safe_redirect( admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=webhooks&edit-webhook=' . $webhook->get_id() . '&error=' . rawurlencode( $result->get_error_message() ) ) );
exit();
}
}
// Redirect to webhook edit page to avoid settings save actions.
wp_safe_redirect( admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=webhooks&edit-webhook=' . $webhook->get_id() . '&updated=1' ) );
exit();
}
/**
* Bulk delete.
*
* @param array $webhooks List of webhooks IDs.
*/
public static function bulk_delete( $webhooks ) {
foreach ( $webhooks as $webhook_id ) {
$webhook = new WC_Webhook( (int) $webhook_id );
$webhook->delete( true );
}
$qty = count( $webhooks );
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$status = isset( $_GET['status'] ) ? '&status=' . sanitize_text_field( wp_unslash( $_GET['status'] ) ) : '';
// Redirect to webhooks page.
wp_safe_redirect( admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=webhooks' . $status . '&deleted=' . $qty ) );
exit();
}
/**
* Delete webhook.
*/
private function delete() {
check_admin_referer( 'delete-webhook' );
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['delete'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$webhook_id = absint( $_GET['delete'] );
if ( $webhook_id ) {
self::bulk_delete( array( $webhook_id ) );
}
}
}
/**
* Webhooks admin actions.
*/
public function actions() {
if ( $this->is_webhook_settings_page() ) {
// Save.
// phpcs:ignore WordPress.Security.NonceVerification.Missing
if ( isset( $_POST['save'] ) && isset( $_POST['webhook_id'] ) ) {
$this->save();
}
// Delete webhook.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['delete'] ) ) {
$this->delete();
}
}
}
/**
* Page output.
*/
public static function page_output() {
// Hide the save button.
$GLOBALS['hide_save_button'] = true;
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['edit-webhook'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$webhook_id = absint( $_GET['edit-webhook'] );
$webhook = new WC_Webhook( $webhook_id );
include __DIR__ . '/settings/views/html-webhooks-edit.php';
return;
}
self::table_list_output();
}
/**
* Notices.
*/
public static function notices() {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['deleted'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$deleted = absint( $_GET['deleted'] );
/* translators: %d: count */
WC_Admin_Settings::add_message( sprintf( _n( '%d webhook permanently deleted.', '%d webhooks permanently deleted.', $deleted, 'woocommerce' ), $deleted ) );
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['updated'] ) ) {
WC_Admin_Settings::add_message( __( 'Webhook updated successfully.', 'woocommerce' ) );
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['created'] ) ) {
WC_Admin_Settings::add_message( __( 'Webhook created successfully.', 'woocommerce' ) );
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( isset( $_GET['error'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
foreach ( explode( '|', sanitize_text_field( wp_unslash( $_GET['error'] ) ) ) as $message ) {
WC_Admin_Settings::add_error( trim( $message ) );
}
}
}
/**
* Add screen option.
*/
public function screen_option() {
global $webhooks_table_list;
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! isset( $_GET['edit-webhook'] ) && $this->is_webhook_settings_page() ) {
$webhooks_table_list = new WC_Admin_Webhooks_Table_List();
// Add screen option.
add_screen_option(
'per_page',
array(
'default' => 10,
'option' => 'woocommerce_webhooks_per_page',
)
);
}
}
/**
* Table list output.
*/
private static function table_list_output() {
global $webhooks_table_list;
echo '<h2 class="wc-table-list-header">' . esc_html__( 'Webhooks', 'woocommerce' ) . ' <a href="' . esc_url( admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=webhooks&edit-webhook=0' ) ) . '" class="page-title-action">' . esc_html__( 'Add webhook', 'woocommerce' ) . '</a></h2>';
// Get the webhooks count.
$data_store = WC_Data_Store::load( 'webhook' );
$num_webhooks = $data_store->get_count_webhooks_by_status();
$count = array_sum( $num_webhooks );
if ( $count > 0 ) {
$webhooks_table_list->process_bulk_action();
$webhooks_table_list->prepare_items();
echo '<input type="hidden" name="page" value="wc-settings" />';
echo '<input type="hidden" name="tab" value="advanced" />';
echo '<input type="hidden" name="section" value="webhooks" />';
self::maybe_display_legacy_rest_api_warning();
$webhooks_table_list->views();
$webhooks_table_list->search_box( __( 'Search webhooks', 'woocommerce' ), 'webhook' );
$webhooks_table_list->display();
} else {
echo '<div class="woocommerce-BlankState woocommerce-BlankState--webhooks">';
?>
<h2 class="woocommerce-BlankState-message"><?php esc_html_e( 'Webhooks are event notifications sent to URLs of your choice. They can be used to integrate with third-party services which support them.', 'woocommerce' ); ?></h2>
<a class="woocommerce-BlankState-cta button-primary button" href="<?php echo esc_url( admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=webhooks&edit-webhook=0' ) ); ?>"><?php esc_html_e( 'Create a new webhook', 'woocommerce' ); ?></a>
<style type="text/css">#posts-filter .wp-list-table, #posts-filter .tablenav.top, .tablenav.bottom .actions { display: none; }</style>
<?php
}
}
/**
* Display a warning message if the Legacy REST API extension is not installed
* and there are webhooks configured to use the legacy payload format.
*/
private static function maybe_display_legacy_rest_api_warning() {
global $webhooks_table_list;
if ( ! is_null( wc()->api ) ) {
return;
}
$legacy_api_webhooks_count = $webhooks_table_list->get_legacy_api_webhooks_count();
if ( 0 === $legacy_api_webhooks_count ) {
return;
}
?>
<div class='error inline'>
<p><strong>
<?php echo esc_html__( 'Incompatible webhooks warning', 'woocommerce' ); ?>
</strong></p>
<p>
<?php
echo wp_kses_data(
sprintf(
/* translators: %s = webhooks count */
_n(
"There's %d webhook that is configured to be delivered using the Legacy REST API, which has been removed from WooCommerce. This webhook will fail to be sent.",
'There are %d webhooks that are configured to be delivered using the Legacy REST API, which has been removed from WooCommerce. These webhooks will fail to be sent.',
$legacy_api_webhooks_count,
'woocommerce'
),
$legacy_api_webhooks_count,
'woocommerce'
)
);
?>
</p>
<p>
<?php
echo wp_kses(
sprintf(
/* translators: %s = URL */
_n(
'This webhook has the ⚠️ symbol in front of its name in the list below. Please either edit the webhook to use a different delivery format, or install and activate <a href="%s" target="_blank">the WooCommerce Legacy REST API extension</a>.',
'These webhooks have the ⚠️ symbol in front of their names in the list below. Please either edit the webhooks to use a different delivery format, or install and activate <a href="%s" target="_blank">the WooCommerce Legacy REST API extension</a>.',
$legacy_api_webhooks_count,
'woocommerce'
),
'https://wordpress.org/plugins/woocommerce-legacy-rest-api/'
),
array(
'a' => array(
'href' => array(),
'target' => array(),
),
)
);
?>
</p>
<p><strong>
<?php
echo wp_kses_data(
sprintf(
/* translators: %s is an URL */
__( "<a href='%s'>More information</a>", 'woocommerce' ),
'https://developer.woocommerce.com/2023/10/03/the-legacy-rest-api-will-move-to-a-dedicated-extension-in-woocommerce-9-0/'
)
);
?>
</strong></p>
</div>
<?php
}
/**
* Logs output.
*
* @deprecated 3.3.0
* @param WC_Webhook $webhook Deprecated.
*/
public static function logs_output( $webhook = 'deprecated' ) {
wc_deprecated_function( 'WC_Admin_Webhooks::logs_output', '3.3' );
}
/**
* Get the webhook topic data.
*
* @param WC_Webhook $webhook Webhook instance.
*
* @return array
*/
public static function get_topic_data( $webhook ) {
$topic = $webhook->get_topic();
$event = '';
$resource = '';
if ( $topic ) {
list( $resource, $event ) = explode( '.', $topic );
if ( 'action' === $resource ) {
$topic = 'action';
} elseif ( ! in_array( $resource, array( 'coupon', 'customer', 'order', 'product' ), true ) ) {
$topic = 'custom';
}
}
return array(
'topic' => $topic,
'event' => $event,
'resource' => $resource,
);
}
/**
* Get the logs navigation.
*
* @deprecated 3.3.0
* @param int $total Deprecated.
* @param WC_Webhook $webhook Deprecated.
*/
public static function get_logs_navigation( $total, $webhook ) {
wc_deprecated_function( 'WC_Admin_Webhooks::get_logs_navigation', '3.3' );
}
}
new WC_Admin_Webhooks();
