Contents

Code Reference Classes BP_Core_Friends_Widget

BP_Core_Friends_Widget

The Member Connections widget class.

Description

Source

File: bp-friends/classes/class-bp-core-friends-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
class BP_Core_Friends_Widget extends WP_Widget {
 
    /**
     * Class constructor.
     *
     * @since BuddyPress 1.9.0
     */
    function __construct() {
        $widget_ops = array(
            'description'                 => __( 'A dynamic list of recently active, popular, and newest Connections of the displayed member.  Widget is only shown when viewing a member profile.', 'buddyboss' ),
            'classname'                   => 'widget_bp_core_friends_widget buddypress widget',
            'customize_selective_refresh' => true,
        );
        parent::__construct( false, $name = __( '(BB) Connections', 'buddyboss' ), $widget_ops );
 
        if ( is_customize_preview() || is_active_widget( false, false, $this->id_base ) ) {
            add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
        }
    }
 
    /**
     * Enqueue scripts.
     *
     * @since BuddyPress 2.6.0
     */
    public function enqueue_scripts() {
        $min = bp_core_get_minified_asset_suffix();
        wp_enqueue_script( 'bp_core_widget_friends-js', buddypress()->plugin_url . "bp-friends/js/widget-friends{$min}.js", array( 'jquery' ), bp_get_version() );
    }
 
    /**
     * Display the widget.
     *
     * @since BuddyPress 1.9.0
     *
     * @param array $args Widget arguments.
     * @param array $instance The widget settings, as saved by the user.
     */
    function widget( $args, $instance ) {
        global $members_template;
 
        extract( $args );
 
        if ( ! bp_displayed_user_id() ) {
            return;
        }
 
        $user_id = bp_displayed_user_id();
        $link = trailingslashit( bp_displayed_user_domain() . bp_get_friends_slug() );
        $instance['title'] = sprintf( __( "%s's Connections", 'buddyboss' ), bp_get_displayed_user_fullname() );
 
        if ( empty( $instance['friend_default'] ) ) {
            $instance['friend_default'] = 'active';
        }
 
        /**
         * Filters the Connections widget title.
         *
         * @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  $instance 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', $instance['title'], $instance, $this->id_base );
 
        echo $before_widget;
 
        $title = $instance['link_title'] ? '<a href="' . esc_url( $link ) . '">' . esc_html( $title ) . '</a>' : esc_html( $title );
 
        echo $before_title . $title . $after_title;
 
        $members_args = array(
            'user_id'         => absint( $user_id ),
            'type'            => sanitize_text_field( $instance['friend_default'] ),
            'max'             => absint( $instance['max_friends'] ),
            'populate_extras' => 1,
        );
 
        // Back up the global.
        $old_members_template = $members_template;
 
        ?>
 
        <?php if ( bp_has_members( $members_args ) ) : ?>
            <div class="item-options" id="friends-list-options">
                <a href="<?php bp_members_directory_permalink(); ?>" id="newest-friends" <?php if ( $instance['friend_default'] == 'newest' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Newest', 'buddyboss' ); ?></a>
                | <a href="<?php bp_members_directory_permalink(); ?>" id="recently-active-friends" <?php if ( $instance['friend_default'] == 'active' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Active', 'buddyboss' ); ?></a>
                | <a href="<?php bp_members_directory_permalink(); ?>" id="popular-friends" <?php if ( $instance['friend_default'] == 'popular' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Popular', 'buddyboss' ); ?></a>
            </div>
 
            <ul id="friends-list" class="item-list">
                <?php while ( bp_members() ) : bp_the_member(); ?>
                    <li class="vcard">
                        <div class="item-avatar">
                            <a href="<?php bp_member_permalink(); ?>"><?php bp_member_avatar(); ?></a>
                        </div>
 
                        <div class="item">
                            <div class="item-title fn"><a href="<?php bp_member_permalink(); ?>"><?php bp_member_name(); ?></a></div>
                            <div class="item-meta">
                                <?php if ( 'newest' == $instance['friend_default'] ) : ?>
                                    <span class="activity" data-livestamp="<?php bp_core_iso8601_date( bp_get_member_registered( array( 'relative' => false ) ) ); ?>"><?php bp_member_registered(); ?></span>
                                <?php elseif ( 'active' == $instance['friend_default'] ) : ?>
                                    <span class="activity" data-livestamp="<?php bp_core_iso8601_date( bp_get_member_last_active( array( 'relative' => false ) ) ); ?>"><?php bp_member_last_active(); ?></span>
                                <?php else : ?>
                                    <span class="activity"><?php bp_member_total_friend_count(); ?></span>
                                <?php endif; ?>
                            </div>
                        </div>
                    </li>
 
                <?php endwhile; ?>
            </ul>
            <?php wp_nonce_field( 'bp_core_widget_friends', '_wpnonce-friends' ); ?>
            <input type="hidden" name="friends_widget_max" id="friends_widget_max" value="<?php echo absint( $instance['max_friends'] ); ?>" />
 
        <?php else: ?>
 
            <div class="widget-error">
                <?php _e( 'Sorry, no members were found.', 'buddyboss' ); ?>
            </div>
 
        <?php endif; ?>
 
        <?php echo $after_widget;
 
        // Restore the global.
        $members_template = $old_members_template;
    }
 
    /**
     * Process a widget save.
     *
     * @since BuddyPress 1.9.0
     *
     * @param array $new_instance The parameters saved by the user.
     * @param array $old_instance The parameters as previously saved to the database.
     * @return array $instance The processed settings to save.
     */
    function update( $new_instance, $old_instance ) {
        $instance = $old_instance;
 
        $instance['max_friends']    = absint( $new_instance['max_friends'] );
        $instance['friend_default'] = sanitize_text_field( $new_instance['friend_default'] );
        $instance['link_title']     = (bool) $new_instance['link_title'];
 
        return $instance;
    }
 
    /**
     * Render the widget edit form.
     *
     * @since BuddyPress 1.9.0
     *
     * @param array $instance The saved widget settings.
     * @return void
     */
    function form( $instance ) {
        $defaults = array(
            'max_friends'    => 5,
            'friend_default' => 'active',
            'link_title'     => false
        );
        $instance = wp_parse_args( (array) $instance, $defaults );
 
        $max_friends    = $instance['max_friends'];
        $friend_default = $instance['friend_default'];
        $link_title = (bool) $instance['link_title'];
        ?>
 
        <p><label for="<?php echo $this->get_field_id( 'link_title' ); ?>"><input type="checkbox" name="<?php echo $this->get_field_name('link_title'); ?>" id="<?php echo $this->get_field_id( 'link_title' ); ?>" value="1" <?php checked( $link_title ); ?> /> <?php _e( 'Link widget title to Members directory', 'buddyboss' ); ?></label></p>
 
        <p><label for="<?php echo $this->get_field_id( 'max_friends' ); ?>"><?php _e( 'Max connections to show:', 'buddyboss' ); ?> <input class="widefat" id="<?php echo $this->get_field_id( 'max_friends' ); ?>" name="<?php echo $this->get_field_name( 'max_friends' ); ?>" type="text" value="<?php echo absint( $max_friends ); ?>" style="width: 30%" /></label></p>
 
        <p>
            <label for="<?php echo $this->get_field_id( 'friend_default' ) ?>"><?php _e( 'Default connections to show:', 'buddyboss' ); ?></label>
            <select name="<?php echo $this->get_field_name( 'friend_default' ); ?>" id="<?php echo $this->get_field_id( 'friend_default' ); ?>">
                <option value="newest" <?php selected( $friend_default, 'newest' ); ?>><?php _e( 'Newest', 'buddyboss' ); ?></option>
                <option value="active" <?php selected( $friend_default, 'active' );?>><?php _e( 'Active', 'buddyboss' ); ?></option>
                <option value="popular"  <?php selected( $friend_default, 'popular' ); ?>><?php _e( 'Popular', 'buddyboss' ); ?></option>
            </select>
        </p>
 
    <?php
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.9.0 Introduced.

Methods

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.