Bp_Search_Members

BuddyPress Global Search – search members class
Description

Source

File: bp-search/classes/class-bp-search-members.php
    class Bp_Search_Members extends Bp_Search_Type {
        private $type = 'members';
 
        /**
         * Insures that only one instance of Class exists in memory at any
         * one time. Also prevents needing to define globals all over the place.
         *
         * @since BuddyBoss 1.0.0
         *
         * @return object Bp_Search_Members
         */
        public static function instance() {
            // Store the instance locally to avoid private static replication
            static $instance = null;
 
            // Only run these methods if they haven't been run previously
            if (null === $instance) {
                $instance = new Bp_Search_Members();
 
                add_action( 'bp_search_settings_item_members', array( $instance, 'print_search_options' ) );
            }
 
            // Always return the instance
            return $instance;
        }
 
        /**
         * A dummy constructor to prevent this class from being loaded more than once.
         *
         * @since BuddyBoss 1.0.0
         */
        private function __construct() { /* Do nothing here */
        }
 
        /**
         * Generates sql for members search.
         *
         * @todo: if Mr.X has set privacy of xprofile field 'location' data as 'private'
         * then, location of Mr.X shouldn't be checked in searched.
         *
         * @since BuddyBoss 1.0.0
         * @param string $search_term
         * @param boolean $only_totalrow_count
         *
         * @return string sql query
         */
        public function sql( $search_term, $only_totalrow_count=false ){
            global $wpdb, $bp;
 
            $bp_prefix = bp_core_get_table_prefix();
 
            $query_placeholder = array();
 
            $COLUMNS = " SELECT ";
 
            if( $only_totalrow_count ){
                $COLUMNS .= " COUNT( DISTINCT u.id ) ";
            } else {
                $COLUMNS .= " DISTINCT u.id, 'members' as type, u.display_name LIKE %s AS relevance, a.date_recorded as entry_date ";
                $query_placeholder[] = '%'. $search_term .'%';
            }
 
            $FROM = " {$wpdb->users} u LEFT JOIN {$bp->members->table_name_last_activity} a ON a.user_id=u.id AND a.component = 'members' AND a.type = 'last_activity'";
 
            $WHERE = array();
            $WHERE[] = "1=1";
            $WHERE[] = "u.user_status = 0";
            $where_fields = array();
 
            /* ++++++++++++++++++++++++++++++++
             * wp_users table fields
             +++++++++++++++++++++++++++++++ */
            $user_fields = bp_get_search_user_fields();
            if ( ! empty( $user_fields ) ) {
                $conditions_wp_user_table = array();
                foreach ( $user_fields as $user_field => $field_label ) {
 
 
                    if ( ! bp_is_search_user_field_enable( $user_field ) ) {
                        continue;
                    }
 
                    if ( 'user_meta' === $user_field ) {
                        //Search in user meta table for terms
                        $conditions_wp_user_table[] = " ID IN ( SELECT user_id FROM {$wpdb->usermeta} WHERE {$bp_prefix}bp_strip_tags(meta_value) LIKE %s ) ";
                        $query_placeholder[]        = '%' . $search_term . '%';
                    } else {
                        $conditions_wp_user_table[] = $user_field . " LIKE %s ";
                        $query_placeholder[]        = '%' . $search_term . '%';
                    }
 
                }
 
                if ( ! empty( $conditions_wp_user_table ) ) {
 
                    $clause_wp_user_table = "u.id IN ( SELECT ID FROM {$wpdb->users}  WHERE ( ";
                    $clause_wp_user_table .= implode( ' OR ', $conditions_wp_user_table );
                    $clause_wp_user_table .= " ) ) ";
 
                    $where_fields[] = $clause_wp_user_table;
                }
 
            }
            /* _____________________________ */
 
            /* ++++++++++++++++++++++++++++++++
             * xprofile fields
             +++++++++++++++++++++++++++++++ */
            //get all selected xprofile fields
            if( function_exists( 'bp_is_active' ) && bp_is_active( 'xprofile' ) ){
                $groups = bp_xprofile_get_groups( array(
                    'fetch_fields' => true
                ) );
 
                if ( !empty( $groups ) ){
                    $selected_xprofile_fields = array(
                        'word_search'   => array(0), //Search for whole word in field of type checkbox and radio
                        'char_search'   => array(0), //Search for character in field of type textbox, textarea and etc
                    );
 
                    $word_search_field_type = array( 'radio', 'checkbox' );
 
                    foreach ( $groups as $group ){
                        if ( !empty( $group->fields ) ){
                            foreach ( $group->fields as $field ) {
                                if ( bp_is_search_xprofile_enable( $field->id ) ) {
 
                                    if( in_array( $field->type, $word_search_field_type ) ) {
                                        $selected_xprofile_fields['word_search'][] = $field->id;
                                    } else {
                                        $selected_xprofile_fields['char_search'][] = $field->id;
                                    }
                                }
                            }
                        }
                    }
 
                    if( !empty( $selected_xprofile_fields ) ){
                        //u.id IN ( SELECT user_id FROM {$bp->profile->table_name_data} WHERE value LIKE %s )
                        $clause_xprofile_table = "u.id IN ( SELECT user_id FROM {$bp->profile->table_name_data} WHERE ( {$bp_prefix}bp_strip_tags(value) LIKE %s AND field_id IN ( ";
                        $clause_xprofile_table .= implode( ',', $selected_xprofile_fields['char_search'] );
                        $clause_xprofile_table .= ") ) OR ( value REGEXP '[[:<:]]{$search_term}[[:>:]]' AND field_id IN ( ";
                        $clause_xprofile_table .= implode( ',', $selected_xprofile_fields['word_search'] );
                        $clause_xprofile_table .= ") ) ) ";
 
                        $where_fields[] = $clause_xprofile_table;
                        $query_placeholder[] = '%'. $search_term .'%';
                    }
                }
            }
            /* _____________________________ */
 
                        /* ++++++++++++++++++++++++++++++++
             * Search from search string
             +++++++++++++++++++++++++++++++ */
 
                            $split_search_term = explode(' ', $search_term);
 
                            if (count($split_search_term) > 1 ) {
 
                                $clause_search_string_table = "u.id IN ( SELECT user_id FROM {$wpdb->usermeta} WHERE meta_key = 'bbgs_search_string' AND (";
 
                                foreach ( $split_search_term as $k => $sterm ) {
 
                                    if ( $k == 0 ) {
                                        $clause_search_string_table .= " meta_value LIKE %s ";
                                        $query_placeholder[] = '%'. $sterm .'%';
                                    } else {
                                        $clause_search_string_table .= " OR meta_value LIKE %s ";
                                        $query_placeholder[] = '%'. $sterm .'%';
                                    }
                                }
 
                                $clause_search_string_table .= ") ) ";
 
                                $where_fields[] = $clause_search_string_table;
 
                            }
 
                        /* _____________________________ */
 
            if( !empty( $where_fields ) )
                $WHERE[] = '(' . implode ( ' OR ', $where_fields ) . ')';
 
            // other conditions
//          $WHERE[] = " a.component = 'members' ";
//          $WHERE[] = " a.type = 'last_activity' ";
 
            $sql = $COLUMNS . ' FROM ' . $FROM . ' WHERE ' . implode( ' AND ', $WHERE );
            if( !$only_totalrow_count ){
                $sql .= " GROUP BY u.id ";
            }
 
            $sql = $wpdb->prepare( $sql, $query_placeholder );
 
 
                        return apply_filters(
                            'Bp_Search_Members_sql',
                            $sql,
                            array(
                                'search_term'           => $search_term,
                                'only_totalrow_count'   => $only_totalrow_count,
                            )
                        );
        }
 
        protected function generate_html( $template_type='' ){
            $group_ids = array();
 
            foreach( $this->search_results['items'] as $item_id => $item ){
                $group_ids[] = $item_id;
            }
 
            do_action( 'bp_before_search_members_html' );
 
            //now we have all the posts
            //lets do a groups loop
            if ( bp_has_members( array(
                'search_terms' => '',
                'include'      => $group_ids,
                'per_page'     => count( $group_ids )
            ) ) ) {
                while ( bp_members() ) {
                    bp_the_member();
 
                    $result_item = array(
                        'id'    => bp_get_member_user_id(),
                        'type'  => $this->type,
                        'title' => bp_get_member_name(),
                        'html'  => bp_search_buffer_template_part( 'loop/member', $template_type, false ),
                    );
 
                    $this->search_results['items'][ bp_get_member_user_id() ] = $result_item;
                }
            }
 
            do_action( 'bp_after_search_members_html' );
        }
 
        /**
         * What fields members should be searched on?
         * Prints options to search through username, email, nicename/displayname.
         * Prints xprofile fields, if xprofile component is active.
         *
         * @since BuddyBoss 1.0.0
         */
        function print_search_options( $items_to_search ){
            echo "<div class='wp-user-fields' style='margin: 10px 0 0 30px'>";
            echo "<p class='xprofile-group-name' style='margin: 5px 0'><strong>" . __('Account','buddyboss') . "</strong></p>";
 
            $fields = array(
                'user_login'    => __( 'Username/Login', 'buddyboss' ),
                'display_name'  => __( 'Display Name', 'buddyboss' ),
                'user_email'    => __( 'Email', 'buddyboss' ),
                'user_meta'     => __( 'User Meta', 'buddyboss' )
            );
            foreach( $fields as $field=>$label ){
                $item = 'member_field_' . $field;
                $checked = !empty( $items_to_search ) && in_array( $item, $items_to_search ) ? ' checked' : '';
                echo "<label><input type='checkbox' value='{$item}' name='bp_search_plugin_options[items-to-search][]' {$checked}>{$label}</label><br>";
            }
 
            echo "</div><!-- .wp-user-fields -->";
 
            if( !function_exists( 'bp_is_active' ) || !bp_is_active( 'xprofile' ) )
                return;
 
            $groups = bp_xprofile_get_groups( array(
                'fetch_fields' => true
            ) );
 
            if ( !empty( $groups ) ){
                echo "<div class='xprofile-fields' style='margin: 0 0 10px 30px'>";
                foreach ( $groups as $group ){
                    echo "<p class='xprofile-group-name' style='margin: 5px 0'><strong>" . $group->name . "</strong></p>";
 
                    if ( !empty( $group->fields ) ){
                        foreach ( $group->fields as $field ) {
                            //lets save these as xprofile_field_{field_id}
                            $item = 'xprofile_field_' . $field->id;
                            $checked = !empty( $items_to_search ) && in_array( $item, $items_to_search ) ? ' checked' : '';
                            echo "<label><input type='checkbox' value='{$item}' name='bp_search_plugin_options[items-to-search][]' {$checked}>{$field->name}</label><br>";
                        }
                    }
                }
                echo "</div><!-- .xprofile-fields -->";
            }
        }
    }
Expand full source code Collapse full source code
Uses

Uses
Uses	Description
bp-search/classes/class-bp-search-types.php: Bp_Search_Type	BuddyPress Global Search Type – Parent class
Methods

__construct — A dummy constructor to prevent this class from being loaded more than once.
generate_html
instance — Insures that only one instance of Class exists in memory at any one time. Also prevents needing to define globals all over the place.
print_search_options — What fields members should be searched on? Prints options to search through username, email, nicename/displayname.
sql — Generates sql for members search.
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.
Contents

Description

Source

Related

Uses

Methods

Questions?
