Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
04/15/2016 04:59:34 AM (10 years ago)
Author:
tw2113
Message:

Plenty of @since tag updates for the Members component.

See #6402.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-members/bp-members-functions.php

    r10665 r10711  
    3636 * In general, fallback values are only used during initial BP page creation,
    3737 * when no slugs have been explicitly defined.
     38 *
     39 * @since 1.5.0
    3840 */
    3941function bp_core_define_slugs() {
    … …  
    7577 * need backward compatibility with BP_Core_User::get_users(), filter the
    7678 * bp_use_legacy_user_query value, returning true.
     79 *
     80 * @since 1.2.0
    7781 *
    7882 * @param array|string $args {
    … …  
    159163 * Return the domain for the passed user: e.g. http://example.com/members/andy/.
    160164 *
     165 * @since 1.0.0
     166 *
    161167 * @param int         $user_id       The ID of the user.
    162168 * @param string|bool $user_nicename Optional. user_nicename of the user.
    … …  
    199205 * Fetch everything in the wp_users table for a user, without any usermeta.
    200206 *
     207 * @since 1.2.0
     208 *
    201209 * @param int $user_id The ID of the user.
    202210 * @return array
    … …  
    293301 * This function is sensitive to the BP_ENABLE_USERNAME_COMPATIBILITY_MODE,
    294302 * so it will return the user_login or user_nicename as appropriate.
     303 *
     304 * @since 1.0.0
    295305 *
    296306 * @param int         $user_id       User ID to check.
    … …  
    436446 * Return the email address for the user based on user ID.
    437447 *
     448 * @since 1.0.0
     449 *
    438450 * @param int $uid User ID to check.
    439451 * @return string The email for the matched user. Empty string if no user
    … …  
    473485 *
    474486 * Optional parameters will return just the name or just the URL.
     487 *
     488 * @since 1.0.0
    475489 *
    476490 * @param int  $user_id   User ID to check.
    … …  
    599613 * Fetch the display name for a user.
    600614 *
     615 * @since 1.0.1
     616 *
    601617 * @param int|string|bool $user_id_or_username User ID or username.
    602618 * @return string|bool The display name for the user in question, or false if
    … …  
    644660 * Return the user link for the user based on user email address.
    645661 *
     662 * @since 1.0.0
     663 *
    646664 * @param string $email The email address for the user.
    647665 * @return string The link to the users home base. False on no match.
    … …  
    662680/**
    663681 * Return the user link for the user based on the supplied identifier.
     682 *
     683 * @since 1.0.0
    664684 *
    665685 * @param string $username If BP_ENABLE_USERNAME_COMPATIBILITY_MODE is set,
    … …  
    692712 * {@link bp_core_get_active_member_count()}.
    693713 *
     714 * @since 1.2.0
     715 *
    694716 * @return int The total number of members.
    695717 */
    … …  
    717739/**
    718740 * Return the total number of members, limited to those members with last_activity.
     741 *
     742 * @since 1.6.0
    719743 *
    720744 * @return int The number of active members.
    … …  
    920944 * Check whether a user has been marked as a spammer.
    921945 *
     946 * @since 1.6.0
     947 *
    922948 * @param int $user_id The ID for the user.
    923949 * @return bool True if spammer, otherwise false.
    … …  
    9831009/**
    9841010 * Check whether a user has been marked as deleted.
     1011 *
     1012 * @since 1.6.0
    9851013 *
    9861014 * @param int $user_id The ID for the user.
    … …  
    12151243 * Get the last activity for a given user.
    12161244 *
     1245 * @since 1.9.0
     1246 *
    12171247 * @param int $user_id The ID of the user.
    12181248 * @return string Time of last activity, in 'Y-m-d H:i:s' format, or an empty
    … …  
    12941324 * Primarily used for self-deletions, as requested through Settings.
    12951325 *
     1326 * @since 1.0.0
     1327 *
    12961328 * @param int $user_id Optional. ID of the user to be deleted. Default: the
    12971329 *                     logged-in user.
    … …  
    13791411 *
    13801412 * Uses multibyte functions when available on the PHP build.
     1413 *
     1414 * @since 1.0.0
    13811415 *
    13821416 * @param string $str String to be upper-cased.
    … …  
    14261460 * Delete last_activity data for the user when the user is deleted.
    14271461 *
     1462 * @since 1.0.0
     1463 *
    14281464 * @param int $user_id The user ID for the user to delete usermeta for.
    14291465 */
    … …  
    14431479 * Check whether the logged-in user can edit settings for the displayed user.
    14441480 *
     1481 * @since 1.5.0
     1482 *
    14451483 * @return bool True if editing is allowed, otherwise false.
    14461484 */
    … …  
    14651503/**
    14661504 * Flush illegal names by getting and setting 'illegal_names' site option.
     1505 *
     1506 * @since 1.2.5
    14671507 */
    14681508function bp_core_flush_illegal_names() {
    … …  
    14731513/**
    14741514 * Add BuddyPress-specific items to the illegal_names array.
     1515 *
     1516 * @since 1.2.7
    14751517 *
    14761518 * @param array|string $value    Illegal names as being saved defined in
    … …  
    16421684 * Validate a user name and email address when creating a new user.
    16431685 *
     1686 * @since 1.2.2
     1687 *
    16441688 * @param string $user_name  Username to validate.
    16451689 * @param string $user_email Email address to validate.
    … …  
    17451789 * Validate blog URL and title provided at signup.
    17461790 *
     1791 * @since 1.2.2
     1792 *
    17471793 * @todo Why do we have this wrapper?
    17481794 *
    … …  
    17681814/**
    17691815 * Process data submitted at user registration and convert to a signup object.
     1816 *
     1817 * @since 1.2.0
    17701818 *
    17711819 * @todo There appears to be a bug in the return value on success.
    … …  
    18661914 * Create a blog and user based on data supplied at user registration.
    18671915 *
     1916 * @since 1.2.2
     1917 *
    18681918 * @param string $blog_domain Domain requested by user.
    18691919 * @param string $blog_path   Path requested by user.
    … …  
    18941944/**
    18951945 * Activate a signup, as identified by an activation key.
     1946 *
     1947 * @since 1.2.2
    18961948 *
    18971949 * @param string $key Activation key.
    … …  
    21362188 * during normal registration, XProfile data is provided directly by the user.
    21372189 *
     2190 * @since 1.2.0
     2191 *
    21382192 * @param int $user_id ID of the user.
    21392193 * @return bool
    … …  
    21632217/**
    21642218 * Get the avatar storage directory for use during registration.
     2219 *
     2220 * @since 1.1.0
    21652221 *
    21662222 * @return string|bool Directory path on success, false on failure.
    … …  
    22002256 * Send activation email to a newly registered user.
    22012257 *
    2202  * @since  2.5.0 Add the $user_login parameter.
     2258 * @since 1.2.2
     2259 * @since 2.5.0 Add the $user_login parameter.
    22032260 *
    22042261 * @param int|bool $user_id    ID of the new user, false if BP_SIGNUPS_SKIP_USER_CREATION is true.
    … …  
    23222379/**
    23232380 * Redirect away from wp-signup.php if BP registration templates are present.
     2381 *
     2382 * @since 1.1.0
    23242383 */
    23252384function bp_core_wpsignup_redirect() {
    … …  
    27422801 */
    27432802function bp_get_current_member_type() {
     2803
     2804    /**
     2805     * Filters the "current" member type, if one is provided, in member directories.
     2806     *
     2807     * @since 2.3.0
     2808     *
     2809     * @param string $value "Current" member type.
     2810     */
    27442811    return apply_filters( 'bp_get_current_member_type', buddypress()->current_member_type );
    27452812}
Note: See TracChangeset for help on using the changeset viewer.