bp_docs_bracket_link

The BuddyPress Docs bp docs bracket link hook.

Description

apply_filters( 'bp_docs_bracket_link', (string) $a_href_permalink_class_class_link_text_a ); 

Parameters (1)

0. $a_href_permalink_class_class_link_text_a — Optional. (string) => '' . $link_text . ''
The href permalink class class link text a.

Usage

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

Defined (1)

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

/includes/addon-wikitext.php  
  1. return apply_filters( 'bp_docs_bracket_link', '<a href="' . $permalink . '" class="' . $class . '">' . $link_text . '</a>' );