Changeset 9587

Timestamp:

03/03/2015 04:17:10 AM (10 years ago)

Author:

tw2113

Message:

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

See #5940.

File:

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

trunk/src/bp-core/classes/class-bp-members-suggestions.php

@@ -47 +47 @@
     public function validate() {
         $this->args['only_friends'] = (bool) $this->args['only_friends'];
+
+        /**
+         * Filters the members suggestions args for the current user.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param array                  $args Array of arguments for the member suggestions.
+         * @param BP_Members_Suggestions $this Current BP_Members_Suggestions instance.
+         */
         $this->args                 = apply_filters( 'bp_members_suggestions_args', $this->args, $this );
 
@@ -54 +63 @@
         }
 
+        /**
+         * Filters the validation status for the suggestion service query.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param bool|WP_Error          $value Results of validation check.
+         * @param BP_Members_Suggestions $this  Current BP_Members_Suggestions instance.
+         */
         return apply_filters( 'bp_members_suggestions_validate_args', parent::validate(), $this );
     }
@@ -80 +97 @@
         }
 
+        /**
+         * Filters the members suggestions query args.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param array                  $user_query Array of query arguments.
+         * @param BP_Members_Suggestions $this       Current BP_Members_Suggestions instance.
+         */
         $user_query = apply_filters( 'bp_members_suggestions_query_args', $user_query, $this );
         if ( is_wp_error( $user_query ) ) {
@@ -98 +123 @@
         }
 
+        /**
+         * Filters the members suggestions results.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param array                  $results Array of users to suggest.
+         * @param BP_Members_Suggestions $this    Current BP_Members_Suggestions instance.
+         */
         return apply_filters( 'bp_members_suggestions_get_suggestions', $results, $this );
     }