woocommerce_rest_order_actions_email_valid_template_classes │ filter-hook │ WC 9.8.0

Filter the list of valid email templates for a given order.

Note that the email class must also exist in WC_Emails::$emails.

When adding a custom email template to this list, a callback must also be added to trigger the sending of the email. See the woocommerce_rest_order_actions_email_send hook.

Usage

add_filter( 'woocommerce_rest_order_actions_email_valid_template_classes', 'wp_kama_woocommerce_rest_order_actions_email_valid_template_classes_filter', 10, 2 );

/**
 * Function for `woocommerce_rest_order_actions_email_valid_template_classes` filter-hook.
 * 
 * @param string[] $valid_template_classes Array of email template class names that are valid for a given order.
 * @param WC_Order $order                  The order.
 *
 * @return string[]
 */
function wp_kama_woocommerce_rest_order_actions_email_valid_template_classes_filter( $valid_template_classes, $order ){

	// filter...
	return $valid_template_classes;
}

$valid_template_classes(string[])

Array of email template class names that are valid for a given order.

$order(WC_Order)

The order.

Changelog

Where the hook is called

$valid_template_classes = apply_filters(
	'woocommerce_rest_order_actions_email_valid_template_classes',
	$valid_template_classes,
	$order
);

Where the hook is used in WooCommerce

add_filter( 'woocommerce_rest_order_actions_email_valid_template_classes', array( $this, 'add_to_valid_template_classes' ), 10, 2 );

add_filter( 'woocommerce_rest_order_actions_email_valid_template_classes', array( $this, 'add_to_valid_template_classes' ), 10, 2 );