bp_docs_enable_folders_for_current_context

The BuddyPress Docs bp docs enable folders for current context hook.

Description

apply_filters( 'bp_docs_enable_folders_for_current_context', (bool) $bool_enable ); 

Parameters (1)

0. $bool_enable (bool) => (bool) $enable
The bool enable.

Usage

To run the hook, copy the example below.
  1. $bool_enable = apply_filters( 'bp_docs_enable_folders_for_current_context', $bool_enable ); 
  2.  
  3. if ( !empty( $bool_enable ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bp_docs_enable_folders_for_current_context callback 
  2. function filter_bp_docs_enable_folders_for_current_context( $bool_enable ) { 
  3. // make filter magic happen here... 
  4. return $bool_enable
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_docs_enable_folders_for_current_context', 'filter_bp_docs_enable_folders_for_current_context', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_docs_enable_folders_for_current_context', 'filter_bp_docs_enable_folders_for_current_context', 10, 1 ); 

Defined (1)

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

/includes/addon-folders.php  
  1. return apply_filters( 'bp_docs_enable_folders_for_current_context', (bool) $enable );