bp_get_the_topic_is_last_page

Filters whether or not a user is on the last page in the current topic.

Description

apply_filters( 'bp_get_the_topic_is_last_page', (number) $topic_template_pag_page_topic_template_pag_total_pages ); 

Parameters (1)

0. $topic_template_pag_page_topic_template_pag_total_pages (number)
The topic template pag page topic template pag total pages.

Usage

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

Defined (1)

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

/bp-forums/bp-forums-template.php  
  1. return apply_filters( 'bp_get_the_topic_is_last_page', $topic_template->pag_page == $topic_template->pag->total_pages );