bp_docs_enable_attachments

The BuddyPress Docs bp docs enable attachments hook.

Description

apply_filters( 'bp_docs_enable_attachments', (string) $yes_enabled ); 

Parameters (1)

0. $yes_enabled — Optional. (string) => 'yes' === $enabled
The yes enabled.

Usage

To run the hook, copy the example below.
  1. $yes_enabled = apply_filters( 'bp_docs_enable_attachments', $yes_enabled ); 
  2.  
  3. if ( !empty( $yes_enabled ) ) { 
  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_attachments callback 
  2. function filter_bp_docs_enable_attachments( $yes_enabled ) { 
  3. // make filter magic happen here... 
  4. return $yes_enabled
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_docs_enable_attachments', 'filter_bp_docs_enable_attachments', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_docs_enable_attachments', 'filter_bp_docs_enable_attachments', 10, 1 ); 

Defined (1)

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

/includes/attachments.php  
  1. return apply_filters( 'bp_docs_enable_attachments', 'yes' === $enabled );