Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:43:55 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Members Component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-members/classes/class-bp-signup.php

    r9877 r10149  
    11<?php
    2 
    32/**
    43 * Signups Management class.
    54 *
     5 * @since 2.0.0
     6 *
    67 * @package BuddyPress
    78 * @subpackage coreClasses
    8  *
    9  * @since BuddyPress (2.0.0)
    109 */
     10
    1111class BP_Signup {
    1212
     
    7373     * Class constructor.
    7474     *
    75      * @since BuddyPress (2.0.0)
     75     * @since 2.0.0
    7676     *
    7777     * @param integer $signup_id The ID for the signup being queried.
     
    8787     * Populate the instantiated class with data based on the signup_id provided.
    8888     *
    89      * @since BuddyPress (2.0.0)
     89     * @since 2.0.0
    9090     */
    9191    public function populate() {
     
    109109     * Fetch signups based on parameters.
    110110     *
    111      * @since BuddyPress (2.0.0)
     111     * @since 2.0.0
    112112     *
    113113     * @param array $args the argument to retrieve desired signups.
     
    180180         * Filters the Signups paged query.
    181181         *
    182          * @since BuddyPress (2.0.0)
     182         * @since 2.0.0
    183183         *
    184184         * @param string $value SQL statement.
     
    241241         * Filters the Signups count query.
    242242         *
    243          * @since BuddyPress (2.0.0)
     243         * @since 2.0.0
    244244         *
    245245         * @param string $value SQL statement.
     
    256256     * Add a signup.
    257257     *
    258      * @since BuddyPress (2.0.0)
     258     * @since 2.0.0
    259259     *
    260260     * @param array $args
     
    297297         * Filters the result of a signup addition.
    298298         *
    299          * @since BuddyPress (2.0.0)
     299         * @since 2.0.0
    300300         *
    301301         * @param int|bool $retval Newly added user ID on success, false on failure.
     
    314314     * default behavior.
    315315     *
    316      * @since BuddyPress (2.0.0)
     316     * @since 2.0.0
    317317     *
    318318     * @param string $user_login    User login string.
     
    370370         * Filters the user ID for the backcompat functionality.
    371371         *
    372          * @since BuddyPress (2.0.0)
     372         * @since 2.0.0
    373373         *
    374374         * @param int $user_id User ID being registered.
     
    380380     * Check a user status (from wp_users) on a non-multisite config.
    381381     *
    382      * @since BuddyPress (2.0.0)
     382     * @since 2.0.0
    383383     *
    384384     * @param int $user_id ID of the user being checked.
     
    398398         * Filters the user status of a provided user ID.
    399399         *
    400          * @since BuddyPress (2.0.0)
     400         * @since 2.0.0
    401401         *
    402402         * @param int $value User status of the provided user ID.
     
    408408     * Activate a signup.
    409409     *
    410      * @since BuddyPress (2.0.0)
     410     * @since 2.0.0
    411411     *
    412412     * @param string $key Activation key.
     
    445445         * Filters the status of the activated user.
    446446         *
    447          * @since BuddyPress (2.0.0)
     447         * @since 2.0.0
    448448         *
    449449         * @param bool $activated Whether or not the activation was successful.
     
    455455     * How many inactive signups do we have?
    456456     *
    457      * @since BuddyPress (2.0.0)
     457     * @since 2.0.0
    458458     *
    459459     * @return int The number of signups.
     
    468468         * Filters the total inactive signups.
    469469         *
    470          * @since BuddyPress (2.0.0)
     470         * @since 2.0.0
    471471         *
    472472         * @param int $count_signups How many total signups there are.
     
    481481     * email was sent and how many times activation was sent.
    482482     *
    483      * @since BuddyPress (2.0.0)
     483     * @since 2.0.0
    484484     *
    485485     * @param array $args
     
    526526         * Filters the signup ID which received a meta update.
    527527         *
    528          * @since BuddyPress (2.0.0)
     528         * @since 2.0.0
    529529         *
    530530         * @param int $value The signup ID.
     
    536536     * Resend an activation email.
    537537     *
    538      * @since BuddyPress (2.0.0)
     538     * @since 2.0.0
    539539     *
    540540     * @param array $signup_ids Single ID or list of IDs to resend.
     
    560560         * Fires before activation emails are resent.
    561561         *
    562          * @since BuddyPress (2.0.0)
     562         * @since 2.0.0
    563563         *
    564564         * @param array $signup_ids Array of IDs to resend activation emails to.
     
    606606         * Fires after activation emails are resent.
    607607         *
    608          * @since BuddyPress (2.0.0)
     608         * @since 2.0.0
    609609         *
    610610         * @param array $signup_ids Array of IDs to resend activation emails to.
     
    616616         * Filters the result of the metadata for signup activation email resends.
    617617         *
    618          * @since BuddyPress (2.0.0)
     618         * @since 2.0.0
    619619         *
    620620         * @param array $result Updated metadata related to activation emails.
     
    626626     * Activate a pending account.
    627627     *
    628      * @since BuddyPress (2.0.0)
     628     * @since 2.0.0
    629629     *
    630630     * @param array $signup_ids Single ID or list of IDs to activate.
     
    650650         * Fires before activation of user accounts.
    651651         *
    652          * @since BuddyPress (2.0.0)
     652         * @since 2.0.0
    653653         *
    654654         * @param array $signup_ids Array of IDs to activate.
     
    689689         * Fires after activation of user accounts.
    690690         *
    691          * @since BuddyPress (2.0.0)
     691         * @since 2.0.0
    692692         *
    693693         * @param array $signup_ids Array of IDs activated activate.
     
    699699         * Filters the result of the metadata after user activation.
    700700         *
    701          * @since BuddyPress (2.0.0)
     701         * @since 2.0.0
    702702         *
    703703         * @param array $result Updated metadata related to user activation.
     
    709709     * Delete a pending account.
    710710     *
    711      * @since BuddyPress (2.0.0)
     711     * @since 2.0.0
    712712     *
    713713     * @param array $signup_ids Single ID or list of IDs to delete.
     
    735735         * Fires before deletion of pending accounts.
    736736         *
    737          * @since BuddyPress (2.0.0)
     737         * @since 2.0.0
    738738         *
    739739         * @param array $signup_ids Array of pending IDs to delete.
     
    777777         * Fires after deletion of pending accounts.
    778778         *
    779          * @since BuddyPress (2.0.0)
     779         * @since 2.0.0
    780780         *
    781781         * @param array $signup_ids Array of pending IDs to delete.
     
    787787         * Filters the result of the metadata for deleted pending accounts.
    788788         *
    789          * @since BuddyPress (2.0.0)
     789         * @since 2.0.0
    790790         *
    791791         * @param array $result Updated metadata related to deleted pending accounts.
Note: See TracChangeset for help on using the changeset viewer.