bp_admin_email_add_codex_notice

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

Description

bp_admin_email_add_codex_notice(); 

Usage

  1. if ( !function_exists( 'bp_admin_email_add_codex_notice' ) ) { 
  2. require_once ABSPATH . PLUGINDIR . 'buddypress/bp-core/admin/bp-core-admin-functions.php'; 
  3.  
  4.  
  5. // NOTICE! Understand what this does before running. 
  6. $result = bp_admin_email_add_codex_notice(); 
  7.  

Defined (1)

The function is defined in the following location(s).

/bp-core/admin/bp-core-admin-functions.php  
  1. function bp_admin_email_add_codex_notice() { 
  2. if ( get_current_screen()->post_type !== bp_get_email_post_type() ) { 
  3. return; 
  4.  
  5. sprintf( 
  6. __( 'Phrases wrapped in braces <code>{{ }}</code> are email tokens. <a href="%s">Learn about tokens on the BuddyPress Codex</a>.', buddypress ),  
  7. esc_url( 'https://codex.buddypress.org/emails/email-tokens/' ) 
  8. ),  
  9. error 
  10. );