forum_link

The BuddyPress forum link hook.

Description

apply_filters( 'forum_link', (unknown) $get_forum_link, (unknown) $forum_id, (unknown) $context ); 

Parameters (3)

0. $get_forum_link (unknown) => get_forum_link( $forum_id, $page, $context )
The get forum link.
1. $forum_id (unknown)
The forum id.
2. $context (unknown)
The context.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-template.php  
  1. echo apply_filters('forum_link', get_forum_link( $forum_id, $page, $context ), $forum_id, $context );