Changeset 9492

Timestamp:

02/17/2015 06:54:37 AM (10 years ago)

Author:

tw2113

Message:

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

See #5943.

File:

• trunk/src/bp-groups/classes/class-bp-groups-member-suggestions.php (modified) (4 diffs)

trunk/src/bp-groups/classes/class-bp-groups-member-suggestions.php

@@ -48 +48 @@
     public function validate() {
         $this->args['group_id'] = (int) $this->args['group_id'];
+
+        /**
+         * Filters the arguments used to validate and sanitize suggestion service query.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param array                        $args  Array of arguments for the suggestion service query.
+         * @param BP_Groups_Member_Suggestions $this  Instance of the current suggestion class.
+         */
         $this->args             = apply_filters( 'bp_groups_member_suggestions_args', $this->args, $this );
 
@@ -65 +74 @@
         }
 
+        /**
+         * Filters the validation results for the suggestion service query.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param bool|WP_Error                $value True if valid, WP_Error if not.
+         * @param BP_Groups_Member_Suggestions $this  Instance of the current suggestion class.
+         */
         return apply_filters( 'bp_groups_member_suggestions_validate_args', parent::validate(), $this );
     }
@@ -116 +133 @@
         }
 
+        /**
+         * Filters the arguments for the user query for the Suggestion API.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param array                        $user_query Array of arguments for the query.
+         * @param BP_Groups_Member_Suggestions $this       Instance of the current suggestion class.
+         */
         $user_query = apply_filters( 'bp_groups_member_suggestions_query_args', $user_query, $this );
         if ( is_wp_error( $user_query ) ) {
@@ -138 +163 @@
         }
 
+        /**
+         * Filters the results of the member suggestions user query.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param array                        $results Array of member suggestions.
+         * @param BP_Groups_Member_Suggestions $this    Instance of the current suggestion class.
+         */
         return apply_filters( 'bp_groups_member_suggestions_get_suggestions', $results, $this );
     }