woocommerce_coupon_error │ filter-hook │ WC 1.0

Filter the coupon error message.

Usage

add_filter( 'woocommerce_coupon_error', 'wp_kama_woocommerce_coupon_error_filter', 10, 3 );

/**
 * Function for `woocommerce_coupon_error` filter-hook.
 * 
 * @param string    $error_message Error message.
 * @param int       $error_code    Error code.
 * @param WC_Coupon $coupon        Coupon data.
 *
 * @return string
 */
function wp_kama_woocommerce_coupon_error_filter( $error_message, $error_code, $coupon ){

	// filter...
	return $error_message;
}

$error_message(string)

Error message.

$error_code(int)

Error code.

$coupon(WC_Coupon)

Coupon data.

Where the hook is called

$message = apply_filters( 'woocommerce_coupon_error', is_numeric( $e->getMessage() ) ? $coupon->get_coupon_error( $e->getMessage() ) : $e->getMessage(), $e->getCode(), $coupon );

return apply_filters( 'woocommerce_coupon_error', $err, $err_code, $this );

return apply_filters( 'woocommerce_coupon_error', $err, $err_code, null );

Where the hook is used in WooCommerce

add_filter( 'woocommerce_coupon_error', array( $this, 'brand_exclusion_error' ), 10, 2 );