bp_docs_doc_breadcrumbs

The BuddyPress Docs bp docs doc breadcrumbs hook.

Description

apply_filters( 'bp_docs_doc_breadcrumbs', (unknown) $crumbs, (unknown) $doc ); 

Parameters (2)

0. $crumbs (unknown)
The crumbs.
1. $doc (unknown)
The doc.

Usage

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

Defined (1)

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

/includes/templatetags.php  
  1. $crumbs = apply_filters( 'bp_docs_doc_breadcrumbs', $crumbs, $doc );