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

Timestamp:

09/27/2015 05:25:02 AM (11 years ago)

Author:

tw2113

Message:

Standardizing our @since tags for the Groups Component.

See #6576.

File:

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

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

@@ -7 +7 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -13 +13 @@
  * Adds support for user at-mentions (for users in a specific Group) to the Suggestions API.
  *
- * @since BuddyPress (2.1.0)
+ * @since 2.1.0
  */
 class BP_Groups_Member_Suggestions extends BP_Members_Suggestions {
@@ -20 +20 @@
          * Default arguments for this suggestions service.
          *
-         * @since BuddyPress (2.1.0)
+         * @since 2.1.0
          * @access protected
          * @var array $args {
@@ -43 +43 @@
          * Validate and sanitise the parameters for the suggestion service query.
          *
-         * @since BuddyPress (2.1.0)
+         * @since 2.1.0
          *
          * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
@@ -53 +53 @@
                  * Filters the arguments used to validate and sanitize suggestion service query.
                  *
-                 * @since BuddyPress (2.1.0)
+                 * @since 2.1.0
                  *
                  * @param array                        $args  Array of arguments for the suggestion service query.
@@ -78 +78 @@
                  * Filters the validation results for the suggestion service query.
                  *
-                 * @since BuddyPress (2.1.0)
+                 * @since 2.1.0
                  *
                  * @param bool|WP_Error                $value True if valid, WP_Error if not.
@@ -89 +89 @@
          * Find and return a list of username suggestions that match the query.
          *
-         * @since BuddyPress (2.1.0)
+         * @since 2.1.0
          *
          * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
@@ -138 +138 @@
                  * Filters the arguments for the user query for the Suggestion API.
                  *
-                 * @since BuddyPress (2.1.0)
+                 * @since 2.1.0
                  *
                  * @param array                        $user_query Array of arguments for the query.
@@ -168 +168 @@
                  * Filters the results of the member suggestions user query.
                  *
-                 * @since BuddyPress (2.1.0)
+                 * @since 2.1.0
                  *
                  * @param array                        $results Array of member suggestions.