bp_core_add_contextual_help_content

Renders contextual help content to contextual help tabs.

Description

(string) bp_core_add_contextual_help_content( (string) $tab = '' ); 

Returns (string)

Parameters (1)

0. $tab — Optional. (string) => ''
Current help content tab.

Usage

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

Defined (1)

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

/bp-core/admin/bp-core-admin-functions.php  
  1. function bp_core_add_contextual_help_content( $tab = '' ) { 
  2.  
  3. switch ( $tab ) { 
  4. case 'bp-comp-overview' : 
  5. $retval = __( 'By default, all but four of the BuddyPress components are enabled. You can selectively enable or disable any of the components by using the form below. Your BuddyPress installation will continue to function. However, the features of the disabled components will no longer be accessible to anyone using the site.', buddypress ); 
  6. break; 
  7.  
  8. case 'bp-page-overview' : 
  9. $retval = __( 'BuddyPress Components use WordPress Pages for their root directory/archive pages. You can change the page associations for each active component by using the form below.', buddypress ); 
  10. break; 
  11.  
  12. case 'bp-settings-overview' : 
  13. $retval = __( 'Extra configuration settings are provided and activated. You can selectively enable or disable any setting by using the form on this screen.', buddypress ); 
  14. break; 
  15.  
  16. case 'bp-profile-overview' : 
  17. $retval = __( 'Your users will distinguish themselves through their profile page. Create relevant profile fields that will show on each users profile.', buddypress ) . '<br /><br />' . __( 'Note: Any fields in the first group will appear on the signup page.', buddypress ); 
  18. break; 
  19.  
  20. default: 
  21. $retval = false; 
  22. break; 
  23.  
  24. // Wrap text in a paragraph tag. 
  25. if ( !empty( $retval ) ) { 
  26. $retval = '<p>' . $retval . '</p>'; 
  27.  
  28. return $retval;