Contents

Code Reference Functions buddyboss_theme_whos_online_widget_heartbeat()

buddyboss_theme_whos_online_widget_heartbeat( $response = array(),  $data = array() )

Periodically update total number of members online for who’s online widget.

Description

Source

File: bp-members/classes/class-bp-core-whos-online-widget.php

308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
function buddyboss_theme_whos_online_widget_heartbeat( $response = array(), $data = array()  ){
    global $members_template;
 
    if ( empty( $data['boss_whos_online_widget'] ) ) {
        return $response;
    }
 
    $number = (int) $data['boss_whos_online_widget'];
 
    ob_start();
 
    // Setup args for querying members.
    $members_args = array(
        'user_id'         => 0,
        'type'            => 'online',
        'per_page'        => $number,
        'max'             => $number,
        'populate_extras' => true,
        'search_terms'    => false,
    );
 
    $total_online = 0;
    if ( function_exists( 'bp_get_total_online_member_count' ) ){
        $total_online  = bp_get_total_online_member_count();
    }
 
    // Back up global.
    $old_members_template = $members_template;
 
    ?>
 
    <?php if ( bp_has_members( $members_args ) ) : ?>
 
        <div class="avatar-block">
 
            <?php while ( bp_members() ) : bp_the_member(); ?>
 
                <div class="item-avatar">
                    <a href="<?php bp_member_permalink(); ?>" class="bp-tooltip" title="<?php bp_member_name(); ?>" data-bp-tooltip-pos="up" data-bp-tooltip="<?php bp_member_name(); ?>"><?php bp_member_avatar(); ?><span class="member-status online"></span></a>
                </div>
 
            <?php endwhile; ?>
 
        </div>
 
        <?php if (  $members_template->total_member_count < $total_online ){ ?>
            <div class="more-block"><a href="<?php bp_members_directory_permalink(); ?>" class="count-more">More<i class="bb-icon-angle-right"></i></a></div>
        <?php } ?>
 
    <?php else: ?>
 
        <div class="widget-error">
            <?php esc_html_e( 'There are no users currently online', 'buddyboss' ); ?>
        </div>
 
    <?php endif; ?>
 
    <?php
 
    // Restore the global.
    $members_template = $old_members_template;
 
    $response['boss_whos_online_widget'] = ob_get_clean();
    $response['boss_whos_online_widget_total'] = $total_online;
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-members/bp-members-template.php: bp_member_name()

Output display name of current member in the loop.
bp-members/bp-members-template.php: bp_member_permalink()

Output the permalink for the current member in the loop.
bp-members/bp-members-template.php: bp_member_avatar()

Output a member’s avatar.
bp-members/bp-members-template.php: bp_has_members()

Initialize the members loop.
bp-members/bp-members-template.php: bp_members()

Check whether there are more members to iterate over.
bp-members/bp-members-template.php: bp_the_member()

Set up the current member inside the loop.
bp-members/bp-members-template.php: bp_members_directory_permalink()

Output member directory permalink.
bp-core/bp-core-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
Show 3 more uses Hide more uses

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.