bp_get_the_thread_subject
Filters the subject of the thread currently being iterated over.
Description
(string) apply_filters( 'bp_get_the_thread_subject', (unknown) $thread_template_thread_last_message_subject );
Returns (string)
$last_message_subject Subject of the thread currently being iterated over.
Parameters (1)
- 0. $thread_template_thread_last_message_subject (unknown)
- The thread template thread last message subject.
Usage
- To run the hook, copy the example below.
- $thread_template_thread_last_message_subject = apply_filters( 'bp_get_the_thread_subject', $thread_template_thread_last_message_subject );
- if ( !empty( $thread_template_thread_last_message_subject ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_get_the_thread_subject callback
- function filter_bp_get_the_thread_subject( $thread_template_thread_last_message_subject ) {
- // make filter magic happen here...
- return $thread_template_thread_last_message_subject;
- };
- // add the filter
- add_filter( 'bp_get_the_thread_subject', 'filter_bp_get_the_thread_subject', 10, 1 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'bp_get_the_thread_subject', 'filter_bp_get_the_thread_subject', 10, 1 );
Defined (1)
The filter is defined in the following location(s).
- /bp-messages/bp-messages-template.php
- return apply_filters( 'bp_get_the_thread_subject', $thread_template->thread->last_message_subject );