Contents

Code Reference Classes BP_Nouveau_Group_Invite_Query

BP_Nouveau_Group_Invite_Query

Query to get members that are not already members of the group

Description

Source

File: bp-templates/bp-nouveau/includes/groups/classes.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
class BP_Nouveau_Group_Invite_Query extends BP_User_Query {
    /**
     * Array of group member ids, cached to prevent redundant lookups
     *
     * @var null|array Null if not yet defined, otherwise an array of ints
     * @since BuddyPress 3.0.0
     */
    protected $group_member_ids;
 
    /**
     * Set up action hooks
     *
     * @since BuddyPress 3.0.0
     */
    public function setup_hooks() {
        add_action( 'bp_pre_user_query_construct', array( $this, 'build_exclude_args' ) );
        add_action( 'bp_pre_user_query', array( $this, 'build_meta_query' ) );
    }
 
    /**
     * Exclude group members from the user query as it's not needed to invite members to join the group.
     *
     * @since BuddyPress 3.0.0
     */
    public function build_exclude_args() {
        $this->query_vars = wp_parse_args( $this->query_vars, array(
            'group_id'     => 0,
            'is_confirmed' => true,
        ) );
 
        $group_member_ids = $this->get_group_member_ids();
 
        // We want to get users that are already members of the group
        $type = 'exclude';
 
        // We want to get invited users who did not confirmed yet
        if ( false === $this->query_vars['is_confirmed'] ) {
            $type = 'include';
        }
 
        // We have to exclude users if set on $this->query_vars_raw["exclude"] parameter
        if ( ! empty( $this->query_vars_raw["exclude"] ) ) {
            $group_member_ids = array_merge( $group_member_ids, explode(',', $this->query_vars_raw["exclude"] ) );
        }
 
        if ( ! empty( $group_member_ids ) ) {
            $this->query_vars[ $type ] = $group_member_ids;
        }
    }
 
    /**
     * Get the members of the queried group
     *
     * @since BuddyPress 3.0.0
     *
     * @return array $ids User IDs of relevant group member ids
     */
    protected function get_group_member_ids() {
        global $wpdb;
 
        if ( is_array( $this->group_member_ids ) ) {
            return $this->group_member_ids;
        }
 
        $bp  = buddypress();
        $sql = array(
            'select'  => "SELECT user_id FROM {$bp->groups->table_name_members}",
            'where'   => array(),
            'orderby' => '',
            'order'   => '',
            'limit'   => '',
        );
 
        /** WHERE clauses *****************************************************/
 
        // Group id
        $sql['where'][] = $wpdb->prepare( 'group_id = %d', $this->query_vars['group_id'] );
 
        if ( false === $this->query_vars['is_confirmed'] ) {
            $sql['where'][] = $wpdb->prepare( 'is_confirmed = %d', (int) $this->query_vars['is_confirmed'] );
            $sql['where'][] = 'inviter_id != 0';
        }
 
        // Join the query part
        $sql['where'] = ! empty( $sql['where'] ) ? 'WHERE ' . implode( ' AND ', $sql['where'] ) : '';
 
        /** ORDER BY clause ***************************************************/
        $sql['orderby'] = 'ORDER BY date_modified';
        $sql['order']   = 'DESC';
 
        /** LIMIT clause ******************************************************/
        $this->group_member_ids = $wpdb->get_col( "{$sql['select']} {$sql['where']} {$sql['orderby']} {$sql['order']} {$sql['limit']}" );
 
        return $this->group_member_ids;
    }
 
    /**
     * @since BuddyPress 3.0.0
     */
    public function build_meta_query( BP_User_Query $bp_user_query ) {
        if ( isset( $this->query_vars['scope'] ) && 'members' === $this->query_vars['scope'] && isset( $this->query_vars['meta_query'] ) ) {
 
            $invites_meta_query = new WP_Meta_Query( $this->query_vars['meta_query'] );
            $meta_sql           = $invites_meta_query->get_sql( 'user', 'u', 'ID' );
 
            if ( empty( $meta_sql['join'] ) || empty( $meta_sql['where'] ) ) {
                return;
            }
 
            $bp_user_query->uid_clauses['select'] .= ' ' . $meta_sql['join'];
            $bp_user_query->uid_clauses['where']  .= ' ' . $meta_sql['where'];
        }
    }
 
    /**
     * @since BuddyPress 3.0.0
     */
    public static function get_inviter_ids( $user_id = 0, $group_id = 0 ) {
        global $wpdb;
 
        if ( empty( $group_id ) || empty( $user_id ) ) {
            return array();
        }
 
        $bp = buddypress();
 
        return $wpdb->get_col( $wpdb->prepare( "SELECT inviter_id FROM {$bp->groups->table_name_members} WHERE user_id = %d AND group_id = %d", $user_id, $group_id ) );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 3.0.0 Introduced.

Uses

Uses
Uses Description
bp-core/classes/class-bp-user-query.php: BP_User_Query

BuddyPress User Query class.

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.