Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/13/2015 02:02:56 AM (10 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Core component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r10012 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    2424 * recommendations provided in the phpDoc blocks, particularly the expected return types.
    2525 *
    26  * @since BuddyPress (2.1.0)
     26 * @since 2.1.0
    2727 */
    2828abstract class BP_Suggestions {
    … …  
    3333     * If your custom service requires further defaults, add them here.
    3434     *
    35      * @since BuddyPress (2.1.0)
     35     * @since 2.1.0
    3636     * @var array
    3737     */
    … …  
    4747     * This includes `$default_args`, as well as the user-supplied values.
    4848     *
    49      * @since BuddyPress (2.1.0)
     49     * @since 2.1.0
    5050     * @var array
    5151     */
    … …  
    5858     *
    5959     * @param array $args Optional. If set, used as the parameters for the suggestions service query.
    60      * @since BuddyPress (2.1.0)
     60     * @since 2.1.0
    6161     */
    6262    public function __construct( array $args = array() ) {
    … …  
    7575     *                         Mandatory.
    7676     * }
    77      * @since BuddyPress (2.1.0)
     77     * @since 2.1.0
    7878     */
    7979    public function set_query( array $args = array() ) {
    … …  
    8787     * If validation fails, you must return a WP_Error object.
    8888     *
    89      * @since BuddyPress (2.1.0)
     89     * @since 2.1.0
    9090     *
    9191     * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
    … …  
    9898         * Filters the arguments to be validated for the BP_Suggestions query.
    9999         *
    100          * @since BuddyPress (2.1.0)
     100         * @since 2.1.0
    101101         *
    102102         * @param BP_Suggestions $value Arguments to be validated.
    … …  
    118118         * Filters the status of validation for the BP_Suggestions query.
    119119         *
    120          * @since BuddyPress (2.1.0)
     120         * @since 2.1.0
    121121         *
    122122         * @param bool           $value Whether or not the values are valid.
    … …  
    135135     * For example: { 'ID': 'admin', 'image': 'http://example.com/logo.png', 'name': 'Name Surname' }
    136136     *
    137      * @since BuddyPress (2.1.0)
     137     * @since 2.1.0
    138138     *
    139139     * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
Note: See TracChangeset for help on using the changeset viewer.