Skip to:
Content

BuddyPress.org

Changeset 9492


Ignore:
Timestamp:
02/17/2015 06:54:37 AM (5 years ago)
Author:
tw2113
Message:

Adds hooks documentation to class-bp-groups-member-suggestions.php.

See #5943.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/classes/class-bp-groups-member-suggestions.php

    r9486 r9492  
    4848    public function validate() {
    4949        $this->args['group_id'] = (int) $this->args['group_id'];
     50
     51        /**
     52         * Filters the arguments used to validate and sanitize suggestion service query.
     53         *
     54         * @since BuddyPress (2.1.0)
     55         *
     56         * @param array                        $args  Array of arguments for the suggestion service query.
     57         * @param BP_Groups_Member_Suggestions $this  Instance of the current suggestion class.
     58         */
    5059        $this->args             = apply_filters( 'bp_groups_member_suggestions_args', $this->args, $this );
    5160
     
    6574        }
    6675
     76        /**
     77         * Filters the validation results for the suggestion service query.
     78         *
     79         * @since BuddyPress (2.1.0)
     80         *
     81         * @param bool|WP_Error                $value True if valid, WP_Error if not.
     82         * @param BP_Groups_Member_Suggestions $this  Instance of the current suggestion class.
     83         */
    6784        return apply_filters( 'bp_groups_member_suggestions_validate_args', parent::validate(), $this );
    6885    }
     
    116133        }
    117134
     135        /**
     136         * Filters the arguments for the user query for the Suggestion API.
     137         *
     138         * @since BuddyPress (2.1.0)
     139         *
     140         * @param array                        $user_query Array of arguments for the query.
     141         * @param BP_Groups_Member_Suggestions $this       Instance of the current suggestion class.
     142         */
    118143        $user_query = apply_filters( 'bp_groups_member_suggestions_query_args', $user_query, $this );
    119144        if ( is_wp_error( $user_query ) ) {
     
    138163        }
    139164
     165        /**
     166         * Filters the results of the member suggestions user query.
     167         *
     168         * @since BuddyPress (2.1.0)
     169         *
     170         * @param array                        $results Array of member suggestions.
     171         * @param BP_Groups_Member_Suggestions $this    Instance of the current suggestion class.
     172         */
    140173        return apply_filters( 'bp_groups_member_suggestions_get_suggestions', $results, $this );
    141174    }
Note: See TracChangeset for help on using the changeset viewer.