Skip to:
Content

BuddyPress.org

Changeset 9587


Ignore:
Timestamp:
03/03/2015 04:17:10 AM (7 years ago)
Author:
tw2113
Message:

Adds hook documentation to class-bp-members-suggestions.php.

See #5940.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/classes/class-bp-members-suggestions.php

    r9486 r9587  
    4747    public function validate() {
    4848        $this->args['only_friends'] = (bool) $this->args['only_friends'];
     49
     50        /**
     51         * Filters the members suggestions args for the current user.
     52         *
     53         * @since BuddyPress (2.1.0)
     54         *
     55         * @param array                  $args Array of arguments for the member suggestions.
     56         * @param BP_Members_Suggestions $this Current BP_Members_Suggestions instance.
     57         */
    4958        $this->args                 = apply_filters( 'bp_members_suggestions_args', $this->args, $this );
    5059
     
    5463        }
    5564
     65        /**
     66         * Filters the validation status for the suggestion service query.
     67         *
     68         * @since BuddyPress (2.1.0)
     69         *
     70         * @param bool|WP_Error          $value Results of validation check.
     71         * @param BP_Members_Suggestions $this  Current BP_Members_Suggestions instance.
     72         */
    5673        return apply_filters( 'bp_members_suggestions_validate_args', parent::validate(), $this );
    5774    }
     
    8097        }
    8198
     99        /**
     100         * Filters the members suggestions query args.
     101         *
     102         * @since BuddyPress (2.1.0)
     103         *
     104         * @param array                  $user_query Array of query arguments.
     105         * @param BP_Members_Suggestions $this       Current BP_Members_Suggestions instance.
     106         */
    82107        $user_query = apply_filters( 'bp_members_suggestions_query_args', $user_query, $this );
    83108        if ( is_wp_error( $user_query ) ) {
     
    98123        }
    99124
     125        /**
     126         * Filters the members suggestions results.
     127         *
     128         * @since BuddyPress (2.1.0)
     129         *
     130         * @param array                  $results Array of users to suggest.
     131         * @param BP_Members_Suggestions $this    Current BP_Members_Suggestions instance.
     132         */
    100133        return apply_filters( 'bp_members_suggestions_get_suggestions', $results, $this );
    101134    }
Note: See TracChangeset for help on using the changeset viewer.