Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:25:02 AM (10 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Groups Component.

See #6576.

File:
1 edited

Legend:

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

    r9906 r10148  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * Adds support for user at-mentions (for users in a specific Group) to the Suggestions API.
    1414 *
    15  * @since BuddyPress (2.1.0)
     15 * @since 2.1.0
    1616 */
    1717class BP_Groups_Member_Suggestions extends BP_Members_Suggestions {
     
    2020     * Default arguments for this suggestions service.
    2121     *
    22      * @since BuddyPress (2.1.0)
     22     * @since 2.1.0
    2323     * @access protected
    2424     * @var array $args {
     
    4343     * Validate and sanitise the parameters for the suggestion service query.
    4444     *
    45      * @since BuddyPress (2.1.0)
     45     * @since 2.1.0
    4646     *
    4747     * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
     
    5353         * Filters the arguments used to validate and sanitize suggestion service query.
    5454         *
    55          * @since BuddyPress (2.1.0)
     55         * @since 2.1.0
    5656         *
    5757         * @param array                        $args  Array of arguments for the suggestion service query.
     
    7878         * Filters the validation results for the suggestion service query.
    7979         *
    80          * @since BuddyPress (2.1.0)
     80         * @since 2.1.0
    8181         *
    8282         * @param bool|WP_Error                $value True if valid, WP_Error if not.
     
    8989     * Find and return a list of username suggestions that match the query.
    9090     *
    91      * @since BuddyPress (2.1.0)
     91     * @since 2.1.0
    9292     *
    9393     * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
     
    138138         * Filters the arguments for the user query for the Suggestion API.
    139139         *
    140          * @since BuddyPress (2.1.0)
     140         * @since 2.1.0
    141141         *
    142142         * @param array                        $user_query Array of arguments for the query.
     
    168168         * Filters the results of the member suggestions user query.
    169169         *
    170          * @since BuddyPress (2.1.0)
     170         * @since 2.1.0
    171171         *
    172172         * @param array                        $results Array of member suggestions.
Note: See TracChangeset for help on using the changeset viewer.