wc_add_notice() │ WC 2.1

Add and store a notice.

Returns

null. Nothing (null).

Usage

wc_add_notice( $message, $notice_type, $data );

$message(string) (required)

The text to display in the notice.

$notice_type(string)

The name of the notice type - either error, success or notice.
Default: 'success'

$data(array)

Optional notice data.
Default: array()

Changelog

wc_add_notice() wc add notice code ^{WC 10.5.0}

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;
	}

	// If this is called before the session is initialized, for example if a plugin includes this file incorrectly on
	// the admin, skip doing anything to prevent errors.
	if ( ! WC()->session ) {
		wc_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before the WooCommerce session is initialized, or places where there is no session, e.g. WordPress admin.', 'woocommerce' ), '10.5' );
		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' => $message,
			'data'   => $data,
		);
	}

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