Changeset 9731 for trunk/src/bp-core/classes/class-bp-suggestions.php

Timestamp:

04/10/2015 12:52:38 AM (10 years ago)

Author:

tw2113

Message:

Adds hooks documentation for class-bp-suggestions.php

Props melhop.
See #5940.

File:

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

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

@@ -93 +93 @@
         $this->args['limit'] = absint( $this->args['limit'] );
         $this->args['term']  = trim( sanitize_text_field( $this->args['term'] ) );
+
+        /**
+         * Filters the arguments to be validated for the BP_Suggestions query.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param BP_Suggestions $value Arguments to be validated.
+         * @param BP_Suggestions $this  Current BP_Suggestions instance.
+         */
         $this->args          = apply_filters( 'bp_suggestions_args', $this->args, $this );
-
 
         // Check for invalid or missing mandatory parameters.
@@ -106 +114 @@
         }
 
+        /**
+         * Filters the status of validation for the BP_Suggestions query.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param bool           $value Whether or not the values are valid.
+         * @param BP_Suggestions $this  Current BP_Suggestions instance.
+         */
         return apply_filters( 'bp_suggestions_validate_args', true, $this );
     }