woocommerce_email_preheader(id) │ filter-hook │ WC 9.9.0

Provides an opportunity to inspect and modify preheader for the email.

Usage

add_filter( 'woocommerce_email_preheader(id)', 'wp_kama_woocommerce_email_preheaderid_filter', 10, 3 );

/**
 * Function for `woocommerce_email_preheader(id)` filter-hook.
 * 
 * @param string      $preheader Preheader of the email.
 * @param object|bool $object    The object (ie, product or order) this email relates to, if any.
 * @param WC_Email    $email     WC_Email instance managing the email.
 *
 * @return string
 */
function wp_kama_woocommerce_email_preheaderid_filter( $preheader, $object, $email ){

	// filter...
	return $preheader;
}

$preheader(string)

Preheader of the email.

$object(object|true|false)

The object (ie, product or order) this email relates to, if any.

$email(WC_Email)

WC_Email instance managing the email.

Changelog

Where the hook is called

$preheader = apply_filters( 'woocommerce_email_preheader' . $this->id, $this->format_string( $this->get_option_or_transient( 'preheader', '' ) ), $this->object, $this );

Where the hook is used in WooCommerce