Contents

Code Reference Functions bp_get_thread()

bp_get_thread( array|string $args = '' )

Initialize the messages template loop for a specific thread and sets thread.

Description

Parameters

$args

(Optional) Array of arguments. All are optional.

  • 'thread_id'
    (int) ID of the thread whose messages you are displaying. Default: if viewing a thread, the thread ID will be parsed from the URL (bp_action_variable( 0 )).
  • 'order'
    (string) 'ASC' or 'DESC'. Default: 'ASC'.
  • 'update_meta_cache'
    (bool) Whether to pre-fetch metadata for queried message items. Default: true.

Default value: ''

Return

(object) thread template.

Source

File: bp-messages/bp-messages-template.php

1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
function bp_get_thread( $args = '' ) {
    global $thread_template;
 
    $r = bp_parse_args( $args, array(
        'thread_id'         => false,
        'order'             => 'DESC',
        'update_meta_cache' => true,
    ), 'thread_has_messages' );
 
    if ( empty( $r['thread_id'] ) && bp_is_messages_component() && bp_is_current_action( 'view' ) ) {
        $r['thread_id'] = (int) bp_action_variable( 0 );
    }
 
    // Set up extra args.
    $extra_args = $r;
    unset( $extra_args['thread_id'], $extra_args['order'] );
 
    $thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'], $extra_args );
 
    return $thread_template;
}

Expand full source code Collapse full source code

Uses

Uses
Uses Description
bp-messages/classes/class-bp-messages-thread-template.php: BP_Messages_Thread_Template::__construct()

Constructor method.
bp-core/bp-core-template.php: bp_is_messages_component()

Check whether the current page is part of the Messages component.
bp-core/bp-core-template.php: bp_is_current_action()

Check to see whether the current page matches a given action.
bp-core/bp-core-template.php: bp_action_variable()

Return the value of a given action variable.
bp-core/bp-core-functions.php: bp_parse_args()

Merge user defined arguments into defaults array.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.