Contents

Code Reference Functions bp_admin_email_add_codex_notice()

bp_admin_email_add_codex_notice()

In emails editor, add notice linking to token documentation on Codex.

Description

Source

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

function bp_admin_email_add_codex_notice() {
	if ( get_current_screen()->post_type !== bp_get_email_post_type() ) {
		return;
	}

	bp_core_add_admin_notice(
		sprintf(
			__( 'Phrases wrapped in braces <code>{{ }}</code> are email tokens. <a href="%s">Learn about email tokens</a>.', 'buddyboss' ),
			bp_core_help_docs_link( 'components/emails/email-tokens.md' )
		),
		'error'
	);
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.5.0 Introduced.

Uses

Uses
Uses Description
bp-core/admin/bp-core-admin-functions.php: bp_core_add_admin_notice()

Add an admin notice to the BP queue.
bp-core/bp-core-functions.php: bp_get_email_post_type()

Returns the name of the email post type.
bp-core/bp-core-functions.php: bp_get_admin_url()

Return the correct admin URL based on BuddyPress and WordPress configuration.

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.