bp_core_add_admin_notice( string $notice = '', string $type = 'updated' )

Add an admin notice to the BP queue.

Description

Messages added with this function are displayed in BuddyPress’s general purpose admin notices box. It is recommended that you hook this function to admin_init, so that your messages are loaded in time.

Parameters

$notice

(string) (Optional) The notice you are adding to the queue.

Default value: ''

$type

(string) (Optional) The notice type; optional. Usually either "updated" or "error".

Default value: 'updated'

Source

File: bp-core/admin/bp-core-admin-functions.php

function bp_core_add_admin_notice( $notice = '', $type = 'updated' ) {

	// Do not add if the notice is empty.
	if ( empty( $notice ) ) {
		return;
	}

	// Double check the object before referencing it.
	if ( ! isset( buddypress()->admin->notices ) ) {
		buddypress()->admin->notices = array();
	}

	// Add the notice.
	buddypress()->admin->notices[] = array(
		'message' => $notice,
		'type'    => $type,
	);
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.5.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.

Used By
Used By	Description
bp-media/bp-media-filters.php: bp_media_activation_notice()	Hook to display admin notices when media component is active
bp-groups/bp-groups-admin.php: bp_groups_admin_groups_type_change_notice()	Display an admin notice upon group type bulk update.
bp-members/classes/class-bp-members-admin.php: BP_Members_Admin::users_type_change_notice()	Display an admin notice upon profile type bulk update.
bp-core/admin/bp-core-admin-functions.php: bp_admin_email_maybe_add_translation_notice()	In admin emails list, for non-en_US locales, add notice explaining how to reinstall emails.
bp-core/admin/bp-core-admin-functions.php: bp_admin_email_add_codex_notice()	In emails editor, add notice linking to token documentation on Codex.
bp-core/admin/bp-core-admin-functions.php: bp_core_admin_user_manage_spammers()	Catch requests to mark individual users as spam/ham from users.php.
bp-core/admin/bp-core-admin-functions.php: bp_core_activation_notice()	Verify that some BP prerequisites are set up properly, and notify the admin if not.
bp-activity/bp-activity-functions.php: bp_activity_favorites_upgrade_data()	Check if BuddyPress activity favorites data needs upgrade & Update to BuddyBoss activity like data

Show 3 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents