Contents

Code Reference Classes BP_Core_Whos_Online_Widget

BP_Core_Whos_Online_Widget

Who’s Online Widget.

Description

Source

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

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
class BP_Core_Whos_Online_Widget extends WP_Widget {
 
    /**
     * Constructor method.
     *
     * @since BuddyPress 1.5.0
     */
    public function __construct() {
        $name        = __( '(BB) Who\'s Online', 'buddyboss' );
        $description = __( 'Profile photos of online users', 'buddyboss' );
        parent::__construct( false, $name, array(
            'description'                 => $description,
            'classname'                   => 'widget_bp_core_whos_online_widget buddypress widget',
            'customize_selective_refresh' => true,
        ) );
    }
 
    /**
     * Display the Who's Online widget.
     *
     * @since BuddyPress 1.0.3
     *
     * @see WP_Widget::widget() for description of parameters.
     *
     * @param array $args     Widget arguments.
     * @param array $instance Widget settings, as saved by the user.
     */
    public function widget( $args, $instance ) {
        global $members_template;
 
        // Get widget settings.
        $settings = $this->parse_settings( $instance );
 
        /**
         * Filters the title of the Who's Online widget.
         *
         * @since BuddyPress 1.8.0
         * @since BuddyPress 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
         *
         * @param string $title    The widget title.
         * @param array  $settings The settings for the particular instance of the widget.
         * @param string $id_base  Root ID for all widgets of this type.
         */
        $title = apply_filters( 'widget_title', $settings['title'], $settings, $this->id_base );
 
        //echo $args['before_widget'] . $args['before_title'] . $title . $args['after_title'];
 
        // Setup args for querying members.
        $members_args = array(
            'user_id'         => 0,
            'type'            => 'online',
            'per_page'        => $settings['max_members'],
            'max'             => $settings['max_members'],
            '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();
        }
 
        $refresh_online_users =  '<a href="" class="bs-widget-reload bs-heartbeat-reload hide" title="reload"><i class="bb-icon-spin6"></i></a>';
 
        echo $args['before_widget'] . $args['before_title'] . $title . $refresh_online_users . $args['after_title'];
 
        // Back up global.
        $old_members_template = $members_template;
 
        $separator = apply_filters( 'bp_members_online_widget_separator', '|' );
 
        ?>
        <div class="item-options" id="who-online-members-list-options">
            <a href="javascript:void(0);" id="online-members" data-content="boss_whos_online_widget_heartbeat">
                <?php esc_html_e( 'Online', 'buddyboss' ); ?>
                <span class="widget-num-count"><?php esc_html_e( $total_online, 'buddyboss'); ?></span>
            </a>
            <?php
            if ( bp_is_active( 'friends' ) ) :
 
                $count = 0;
                if ( bp_is_active( 'friends' ) ) {
 
                    $personal_friend_comma_separated_string = bp_get_friend_ids( bp_loggedin_user_id() );
                    if ( false !== $personal_friend_comma_separated_string ) {
                        $friend_array = explode( ',', $personal_friend_comma_separated_string );
                    }
                    $count = is_array( $friend_array ) ? count( $friend_array ) : 0;
                }
                ?>
                <span class="bp-separator" role="separator"><?php echo esc_html( $separator ); ?></span>
                <a href="javascript:void(0);" id="connection-members" data-content="boss_whos_online_widget_connections">
                    <?php esc_html_e( 'Connections', 'buddyboss' ); ?>
                    <span class="widget-num-count"><?php esc_html_e( $count, 'buddyboss'); ?></span>
                </a> <?php
            endif; ?>
 
        </div>
        <div class="widget-content" id="boss_whos_online_widget_heartbeat" data-max="<?php echo $settings['max_members']; ?>">
            <?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" 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; ?>
        </div>
        <div class="widget-content" id="boss_whos_online_widget_connections" data-max="<?php echo $settings['max_members']; ?>">
            <?php if ( is_user_logged_in() && bp_has_members( 'user_id=' . bp_loggedin_user_id().'&per_page='.$settings['max_members'].'&max='.$settings['max_members'].'&search_terms='.false.'&populate_extras='.true ) ) : ?>
 
                <div class="avatar-block">
                    <?php while ( bp_members() ) : bp_the_member(); ?>
                        <div class="item-avatar">
                            <a href="<?php bp_member_permalink(); ?>" class="bp-tooltip" data-bp-tooltip-pos="up" data-bp-tooltip="<?php bp_member_name(); ?>"><?php bp_member_avatar(); ?><?php
                                $current_time = current_time( 'mysql', 1 );
                                $diff =  strtotime( $current_time ) - strtotime( $members_template->member->last_activity );
                                if ( $diff < 300 ) { // 5 minutes  =  5 * 60 ?>
                                    <span class="member-status online"></span>
                                <?php } ?></a>
                        </div>
                    <?php endwhile; ?>
                </div>
 
                <?php if (  $members_template->total_member_count > (int)$settings['max_members'] ){ ?>
                    <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( 'Sorry, no members were found.', 'buddyboss' ); ?>
                </div>
 
            <?php endif; ?>
        </div>
        <?php echo $args['after_widget'];
 
        // Restore the global.
        $members_template = $old_members_template;
    }
 
    /**
     * Update the Who's Online widget options.
     *
     * @since BuddyPress 1.0.3
     *
     * @param array $new_instance The new instance options.
     * @param array $old_instance The old instance options.
     * @return array $instance The parsed options to be saved.
     */
    public function update( $new_instance, $old_instance ) {
        $instance                = $old_instance;
        $instance['title']       = strip_tags( $new_instance['title'] );
        $instance['max_members'] = strip_tags( $new_instance['max_members'] );
 
        return $instance;
    }
 
    /**
     * Output the Who's Online widget options form.
     *
     * @since BuddyPress 1.0.3
     *
     * @param array $instance Widget instance settings.
     * @return void
     */
    public function form( $instance ) {
 
        // Get widget settings.
        $settings    = $this->parse_settings( $instance );
        $title       = strip_tags( $settings['title'] );
        $max_members = strip_tags( $settings['max_members'] ); ?>
 
        <p>
            <label for="<?php echo $this->get_field_id( 'title' ); ?>">
                <?php esc_html_e( 'Title:', 'buddyboss' ); ?>
                <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" style="width: 100%" />
            </label>
        </p>
 
        <p>
            <label for="<?php echo $this->get_field_id( 'max_members' ); ?>">
                <?php esc_html_e( 'Max members to show:', 'buddyboss' ); ?>
                <input class="widefat" id="<?php echo $this->get_field_id( 'max_members' ); ?>" name="<?php echo $this->get_field_name( 'max_members' ); ?>" type="text" value="<?php echo esc_attr( $max_members ); ?>" style="width: 30%" />
            </label>
        </p>
 
    <?php
    }
 
    /**
     * Merge the widget settings into defaults array.
     *
     * @since BuddyPress 2.3.0
     *
     * @param array $instance Widget instance settings.
     * @return array
     */
    public function parse_settings( $instance = array() ) {
        return bp_parse_args( $instance, array(
            'title'          => __( "Who's Online", 'buddyboss' ),
            'max_members'    => 15,
        ), 'members_widget_settings' );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.3 Introduced.

Methods

  • __construct — Constructor method.
  • form — Output the Who's Online widget options form.
  • parse_settings — Merge the widget settings into defaults array.
  • update — Update the Who's Online widget options.
  • widget — Display the Who's Online widget.

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.