Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/docs/third-party-developers/extensibility/hooks/actions.md

22 KiB
Raw Blame History

Actions

Table of Contents

deprecated_function_run

Fires when a deprecated function is called.

do_action( 'deprecated_function_run' )

Source

woocommerce_add_to_cart

Fires when an item is added to the cart.

do_action( 'woocommerce_add_to_cart', string $cart_id, integer $product_id, integer $request_quantity, integer $variation_id, array $variation, array $cart_item_data )

Note: Matches action name in WooCommerce core.

Description

This hook fires when an item is added to the cart. This is triggered from the Store API in this context, but WooCommerce core add to cart events trigger the same hook.

Parameters

Argument Type Description
$cart_id string ID of the item in the cart.
$product_id integer ID of the product added to the cart.
$request_quantity integer Quantity of the item added to the cart.
$variation_id integer Variation ID of the product added to the cart.
$variation array Array of variation data.
$cart_item_data array Array of other cart item data.

Source

woocommerce_after_main_content

Hook: woocommerce_after_main_content

do_action( 'woocommerce_after_main_content' )

Description

Called after rendering the main content for a product.

See

  • woocommerce_output_content_wrapper_end() - Outputs closing DIV for the content (priority 10)

Source

woocommerce_after_shop_loop

Hook: woocommerce_after_shop_loop.

do_action( 'woocommerce_after_shop_loop' )

See

  • woocommerce_pagination() - Renders pagination (priority 10)

Source

woocommerce_applied_coupon

Fires after a coupon has been applied to the cart.

do_action( 'woocommerce_applied_coupon', string $coupon_code )

Note: Matches action name in WooCommerce core.

Parameters

Argument Type Description
$coupon_code string The coupon code that was applied.

Source

woocommerce_archive_description

Hook: woocommerce_archive_description.

do_action( 'woocommerce_archive_description' )

See

  • woocommerce_taxonomy_archive_description() - Renders the taxonomy archive description (priority 10)
  • woocommerce_product_archive_description() - Renders the product archive description (priority 10)

Source

woocommerce_before_main_content

Hook: woocommerce_before_main_content

do_action( 'woocommerce_before_main_content' )

Description

Called before rendering the main content for a product.

See

  • woocommerce_output_content_wrapper() - Outputs opening DIV for the content (priority 10)
  • woocommerce_breadcrumb() - Outputs breadcrumb trail to the current product (priority 20)
  • WC_Structured_Data::generate_website_data() - Outputs schema markup (priority 30)

Source

woocommerce_before_shop_loop

Hook: woocommerce_before_shop_loop.

do_action( 'woocommerce_before_shop_loop' )

See

  • woocommerce_output_all_notices() - Render error notices (priority 10)
  • woocommerce_result_count() - Show number of results found (priority 20)
  • woocommerce_catalog_ordering() - Show form to control sort order (priority 30)

Source

woocommerce_blocks_cart_enqueue_data

Fires after cart block data is registered.

do_action( 'woocommerce_blocks_cart_enqueue_data' )

Source

woocommerce_blocks_checkout_enqueue_data

Fires after checkout block data is registered.

do_action( 'woocommerce_blocks_checkout_enqueue_data' )

Source

woocommerce_blocks_enqueue_cart_block_scripts_after

Fires after cart block scripts are enqueued.

do_action( 'woocommerce_blocks_enqueue_cart_block_scripts_after' )

Source

woocommerce_blocks_enqueue_cart_block_scripts_before

Fires before cart block scripts are enqueued.

do_action( 'woocommerce_blocks_enqueue_cart_block_scripts_before' )

Source

woocommerce_blocks_enqueue_checkout_block_scripts_after

Fires after checkout block scripts are enqueued.

do_action( 'woocommerce_blocks_enqueue_checkout_block_scripts_after' )

Source

woocommerce_blocks_enqueue_checkout_block_scripts_before

Fires before checkout block scripts are enqueued.

do_action( 'woocommerce_blocks_enqueue_checkout_block_scripts_before' )

Source

woocommerce_blocks_loaded

Fires when the woocommerce blocks are loaded and ready to use.

do_action( 'woocommerce_blocks_loaded' )

Description

This hook is intended to be used as a safe event hook for when the plugin has been loaded, and all dependency requirements have been met.

To ensure blocks are initialized, you must use the woocommerce_blocks_loaded hook instead of the plugins_loaded hook. This is because the functions hooked into plugins_loaded on the same priority load in an inconsistent and unpredictable manner.

Source

woocommerce_blocks_{$this->registry_identifier}_registration

Fires when the IntegrationRegistry is initialized.

do_action( 'woocommerce_blocks_{$this->registry_identifier}_registration', \Automattic\WooCommerce\Blocks\Integrations\IntegrationRegistry $this )

Description

Runs before integrations are initialized allowing new integration to be registered for use. This should be used as the primary hook for integrations to include their scripts, styles, and other code extending the blocks.

Parameters

Argument Type Description
$this \Automattic\WooCommerce\Blocks\Integrations\IntegrationRegistry Instance of the IntegrationRegistry class which exposes the IntegrationRegistry::register() method.

Source

woocommerce_check_cart_items

Fires when cart items are being validated.

do_action( 'woocommerce_check_cart_items' )

Deprecated: This hook is deprecated and will be removed

Note: Matches action name in WooCommerce core.

Description

Allow 3rd parties to validate cart items. This is a legacy hook from Woo core. This filter will be deprecated because it encourages usage of wc_add_notice. For the API we need to capture notices and convert to wp errors instead.

Source

woocommerce_created_customer

Fires after a customer account has been registered.

do_action( 'woocommerce_created_customer', integer $customer_id, array $new_customer_data, string $password_generated )

Note: Matches filter name in WooCommerce core.

Description

This hook fires after customer accounts are created and passes the customer data.

Parameters

Argument Type Description
$customer_id integer New customer (user) ID.
$new_customer_data array Array of customer (user) data.
$password_generated string The generated password for the account.

Source

woocommerce_no_products_found

Hook: woocommerce_no_products_found.

do_action( 'woocommerce_no_products_found' )

See

  • wc_no_products_found() - Default no products found content (priority 10)

Source

woocommerce_register_post

Fires before a customer account is registered.

do_action( 'woocommerce_register_post', string $username, string $user_email, \WP_Error $errors )

Note: Matches filter name in WooCommerce core.

Description

This hook fires before customer accounts are created and passes the form data (username, email) and an array of errors.

This could be used to add extra validation logic and append errors to the array.

Parameters

Argument Type Description
$username string Customer username.
$user_email string Customer email address.
$errors \WP_Error Error object.

Source

woocommerce_shop_loop

Hook: woocommerce_shop_loop.

do_action( 'woocommerce_shop_loop' )

Source

woocommerce_store_api_cart_errors

Fires an action to validate the cart.

do_action( 'woocommerce_store_api_cart_errors', \WP_Error $errors, \WC_Cart $cart )

Description

Functions hooking into this should add custom errors using the provided WP_Error instance.

Parameters

Argument Type Description
$errors \WP_Error WP_Error object.
$cart \WC_Cart Cart object.

Example

Validate Cart

// The action callback function.
function my_function_callback( $errors, $cart ) {

  // Validate the $cart object and add errors. For example, to create an error if the cart contains more than 10 items:
  if ( $cart->get_cart_contents_count() > 10 ) {
    $errors->add( 'my_error_code', 'Too many cart items!' );
  }
}

add_action( 'woocommerce_store_api_cart_errors', 'my_function_callback', 10 );

Source

woocommerce_store_api_cart_select_shipping_rate

Fires an action after a shipping method has been chosen for package(s) via the Store API.

do_action( 'woocommerce_store_api_cart_select_shipping_rate', string|null $package_id, string $rate_id, \WP_REST_Request $request )

Description

This allows extensions to perform addition actions after a shipping method has been chosen, but before the cart totals are recalculated.

Parameters

Argument Type Description
$package_id string, null The sanitized ID of the package being updated. Null if all packages are being updated.
$rate_id string The sanitized chosen rate ID for the package.
$request \WP_REST_Request Full details about the request.

Source

woocommerce_store_api_cart_update_customer_from_request

Fires when the Checkout Block/Store API updates a customer from the API request data.

do_action( 'woocommerce_store_api_cart_update_customer_from_request', \WC_Customer $customer, \WP_REST_Request $request )

Parameters

Argument Type Description
$customer \WC_Customer Customer object.
$request \WP_REST_Request Full details about the request.

Source

woocommerce_store_api_cart_update_order_from_request

Fires when the order is synced with cart data from a cart route.

do_action( 'woocommerce_store_api_cart_update_order_from_request', \WC_Order $draft_order, \WC_Customer $customer, \WP_REST_Request $request )

Parameters

Argument Type Description
$draft_order \WC_Order Order object.
$customer \WC_Customer Customer object.
$request \WP_REST_Request Full details about the request.

Source

woocommerce_store_api_checkout_order_processed

Fires before an order is processed by the Checkout Block/Store API.

do_action( 'woocommerce_store_api_checkout_order_processed', \WC_Order $order )

Description

This hook informs extensions that $order has completed processing and is ready for payment.

This is similar to existing core hook woocommerce_checkout_order_processed. We're using a new action:

  • To keep the interface focused (only pass $order, not passing request data).
  • This also explicitly indicates these orders are from checkout block/StoreAPI.

Parameters

Argument Type Description
$order \WC_Order Order object.

Example

Checkout Order Processed

// The action callback function.
function my_function_callback( $order ) {
  // Do something with the $order object.
  $order->save();
}

add_action( 'woocommerce_blocks_checkout_order_processed', 'my_function_callback', 10 );

See

Source

woocommerce_store_api_checkout_update_customer_from_request

Fires when the Checkout Block/Store API updates a customer from the API request data.

do_action( 'woocommerce_store_api_checkout_update_customer_from_request', \WC_Customer $customer, \WP_REST_Request $request )

Parameters

Argument Type Description
$customer \WC_Customer Customer object.
$request \WP_REST_Request Full details about the request.

Source

woocommerce_store_api_checkout_update_order_meta

Fires when the Checkout Block/Store API updates an order's meta data.

do_action( 'woocommerce_store_api_checkout_update_order_meta', \WC_Order $order )

Description

This hook gives extensions the chance to add or update meta data on the $order. Throwing an exception from a callback attached to this action will make the Checkout Block render in a warning state, effectively preventing checkout.

This is similar to existing core hook woocommerce_checkout_update_order_meta. We're using a new action:

  • To keep the interface focused (only pass $order, not passing request data).
  • This also explicitly indicates these orders are from checkout block/StoreAPI.

Parameters

Argument Type Description
$order \WC_Order Order object.

See

Source

woocommerce_store_api_rate_limit_exceeded

Fires when the rate limit is exceeded.

do_action( 'woocommerce_store_api_rate_limit_exceeded', string $ip_address )

Parameters

Argument Type Description
$ip_address string The IP address of the request.

Source

woocommerce_store_api_validate_add_to_cart

Fires during validation when adding an item to the cart via the Store API.

do_action( 'woocommerce_store_api_validate_add_to_cart', \WC_Product $product, array $request )

Description

Fire action to validate add to cart. Functions hooking into this should throw an \Exception to prevent add to cart from happening.

Parameters

Argument Type Description
$product \WC_Product Product object being added to the cart.
$request array Add to cart request params including id, quantity, and variation attributes.

Source

woocommerce_store_api_validate_cart_item

Fire action to validate add to cart. Functions hooking into this should throw an \Exception to prevent add to cart from occurring.

do_action( 'woocommerce_store_api_validate_cart_item', \WC_Product $product, array $cart_item )

Parameters

Argument Type Description
$product \WC_Product Product object being added to the cart.
$cart_item array Cart item array.

Source

woocommerce_{$product->get_type()}_add_to_cart

Trigger the single product add to cart action for each product type.

do_action( 'woocommerce_{$product->get_type()}_add_to_cart' )

Source

{$hook}

Action to render the content of a hook.

do_action( '{$hook}' )

Source

We're hiring! Come work with us!

🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.