wc_add_notice( string $message, string $notice_type = 'success', array $data = array() )

Add and store a notice.

Contents

Description Description

Parameters Parameters

$message

(Required) The text to display in the notice.

$notice_type

(Optional) The name of the notice type - either error, success or notice.

Default value: 'success'

$data

(Optional) notice data.

Default value: array()

Top ↑

Source Source

File: includes/wc-notice-functions.php 

function wc_add_notice( $message, $notice_type = 'success', $data = array() ) {
	if ( ! did_action( 'woocommerce_init' ) ) {
		wc_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
		return;
	}

	$notices = WC()->session->get( 'wc_notices', array() );

	// Backward compatibility.
	if ( 'success' === $notice_type ) {
		$message = apply_filters( 'woocommerce_add_message', $message );
	}

	$message = apply_filters( 'woocommerce_add_' . $notice_type, $message );

	if ( ! empty( $message ) ) {
		$notices[ $notice_type ][] = array(
			'notice' => apply_filters( 'woocommerce_add_' . $notice_type, $message ),
			'data'   => $data,
		);
	}

	WC()->session->set( 'wc_notices', $notices );
}

Expand full source code Collapse full source code

Top ↑

Changelog Changelog

Changelog
Version Description
2.1 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
woocommerce.php: WC()

Returns the main instance of WC.
includes/wc-deprecated-functions.php: wc_doing_it_wrong()

Wrapper for _doing_it_wrong().

Top ↑

Used By Used By

Used By
Used By Description
includes/wc-notice-functions.php: wc_add_wp_error_notices()

Add notices for WP Errors.
includes/class-wc-cart.php: WC_Cart::apply_coupon()

Applies a coupon code passed to the method.
includes/class-wc-cart.php: WC_Cart::add_to_cart()

Add a product to the cart.
includes/class-wc-cart.php: WC_Cart::check_cart_items()

Check all cart items for errors.
includes/class-wc-ajax.php: WC_AJAX::apply_coupon()

AJAX apply coupon on checkout page.
includes/class-wc-ajax.php: WC_AJAX::remove_coupon()

AJAX remove coupon on cart and checkout page.
includes/wc-template-functions.php: wc_template_redirect()

Handle redirects before content is output – hooked into template_redirect so is_page works.
includes/class-wc-cart-session.php: WC_Cart_Session::get_cart_from_session()

Get the cart data from the PHP session and store it in class variables.
includes/class-wc-cart-session.php: WC_Cart_Session::populate_cart_from_order()

Get a cart from an order, if user has permission.
includes/class-wc-form-handler.php: WC_Form_Handler::process_login()

Process the login form.
includes/class-wc-form-handler.php: WC_Form_Handler::process_reset_password()

Handle reset password form.
includes/class-wc-form-handler.php: WC_Form_Handler::process_registration()

Process the registration form.
includes/class-wc-form-handler.php: WC_Form_Handler::add_to_cart_handler_grouped()

Handle adding grouped products to the cart.
includes/class-wc-form-handler.php: WC_Form_Handler::add_to_cart_handler_variable()

Handle adding variable products to the cart.
includes/class-wc-form-handler.php: WC_Form_Handler::delete_payment_method_action()

Process the delete payment method form.
includes/class-wc-form-handler.php: WC_Form_Handler::set_default_payment_method_action()

Process the delete payment method form.
includes/class-wc-form-handler.php: WC_Form_Handler::update_cart_action()

Remove from cart/update.
includes/class-wc-form-handler.php: WC_Form_Handler::cancel_order()

Cancel a pending order.
includes/class-wc-form-handler.php: WC_Form_Handler::save_account_details()

Save the password/account details and redirect back to the my account page.
includes/class-wc-form-handler.php: WC_Form_Handler::pay_action()

Process the pay form.
includes/class-wc-form-handler.php: WC_Form_Handler::add_payment_method_action()

Process the add payment method form.
includes/class-wc-form-handler.php: WC_Form_Handler::redirect_reset_password_link()

Remove key and user ID (or user login, as a fallback) from query string, set cookie, and redirect to account page to show the form.
includes/class-wc-form-handler.php: WC_Form_Handler::save_address()

Save and and update a billing or shipping address if the form was submitted through the user account page.
includes/wc-cart-functions.php: wc_protected_product_add_to_cart()

Prevent password protected products being added to the cart.
includes/wc-cart-functions.php: wc_add_to_cart_message()

Add to cart messages.
includes/class-wc-shipping.php: WC_Shipping::load_shipping_methods()

Loads all shipping methods which are hooked in.
includes/class-wc-checkout.php: WC_Checkout::process_checkout()

Process the checkout after the confirm order button is pressed.
includes/class-wc-query.php: WC_Query::get_errors()

Get any errors from querystring.
includes/class-wc-coupon.php: WC_Coupon::add_coupon_message()

Converts one of the WC_Coupon message/error codes to a message string and.
includes/shortcodes/class-wc-shortcode-cart.php: WC_Shortcode_Cart::calculate_shipping()

Calculate shipping for the cart.
includes/shortcodes/class-wc-shortcode-checkout.php: WC_Shortcode_Checkout::checkout()

Show the checkout.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::output()

Output the shortcode.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::retrieve_password()

Handles sending password retrieval email to customer.
includes/shortcodes/class-wc-shortcode-my-account.php: WC_Shortcode_My_Account::check_password_reset_key()

Retrieves a user row based on password reset key and login.
Show 29 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.