Skip to:
Content

BuddyPress.org

Changeset 10711


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.

Location:
trunk/src/bp-members
Files:
17 edited

Legend:

Unmodified
Added
Removed

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

    r10417 r10711  
    2323 *
    2424 * Note: no longer used in the current state. See the Settings component.
     25 *
     26 * @since 1.1.0
    2527 *
    2628 * @param int $user_id Optional. User ID to mark as spam. Defaults to displayed user.
    … …  
    7476 *
    7577 * Note: No longer called here. See the Settings component.
     78 *
     79 * @since 1.1.0
    7680 */
    7781function bp_core_action_delete_user() {

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

    r10417 r10711  
    7171 * Create a "became a registered user" activity item when a user activates his account.
    7272 *
     73 * @since 1.2.2
     74 *
    7375 * @param array $user Array of userdata passed to bp_core_activated_user hook.
    7476 * @return bool

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

    r10417 r10711  
    4545                ) ) );
    4646
    47         // Show login and sign-up links.
     47                // Show login and sign-up links.
    4848        } elseif ( !empty( $wp_admin_bar ) ) {
    4949

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

    r10417 r10711  
    5353 * Called when the user is deleted or marked as spam.
    5454 *
    55  * @since BuddyPres (2.2.0)
     55 * @since 2.2.0
    5656 *
    5757 * @param int $user_id ID of the deleted user.

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

    r10417 r10711  
    111111                $profile_link = trailingslashit( bp_core_get_user_domain( $user_id ) . bp_get_profile_slug() . '/edit' );
    112112
    113         // Default to $url.
    114113        } else {
     114                // Default to $url.
    115115                $profile_link = $url;
    116116        }

  • 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}

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

    r10652 r10711  
    1717/**
    1818 * Set up the bp-members component.
     19 *
     20 * @since 1.6.0
    1921 */
    2022function bp_setup_members() {

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

    r10652 r10711  
    2020/**
    2121 * Handle the display of the profile page by loading the correct template file.
     22 *
     23 * @since 1.5.0
    2224 */
    2325function bp_members_screen_display_profile() {
    … …  
    4244/**
    4345 * Handle the display of the members directory index.
     46 *
     47 * @since 1.5.0
    4448 */
    4549function bp_members_screen_index() {
    … …  
    6872/**
    6973 * Handle the loading of the signup screen.
     74 *
     75 * @since 1.1.0
    7076 */
    7177function bp_core_screen_signup() {
    … …  
    102108                $bp->signup->step = 'registration-disabled';
    103109
    104         // If the signup page is submitted, validate and save.
     110                // If the signup page is submitted, validate and save.
    105111        } elseif ( isset( $_POST['signup_submit'] ) && bp_verify_nonce_request( 'bp_new_signup' ) ) {
    106112
    … …  
    154160                                }
    155161
    156                         // This situation doesn't naturally occur so bounce to website root.
     162                                // This situation doesn't naturally occur so bounce to website root.
    157163                        } else {
    158164                                bp_core_redirect( bp_get_root_domain() );
    … …  
    298304 * Handle the loading of the Activate screen.
    299305 *
     306 * @since 1.1.0
     307 *
    300308 * @todo Move the actual activation process into an action in bp-members-actions.php
    301309 */

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

    r10690 r10711  
    293293 * global, enabling the use of BuddyPress templates and template functions to
    294294 * display a list of members.
     295 *
     296 * @since 1.2.0
    295297 *
    296298 * @global object $members_template {@link BP_Members_Template}
    … …  
    439441 * Set up the current member inside the loop.
    440442 *
     443 * @since 1.2.0
     444 *
    441445 * @return object
    442446 */
    … …  
    449453 * Check whether there are more members to iterate over.
    450454 *
     455 * @since 1.2.0
     456 *
    451457 * @return bool
    452458 */
    … …  
    458464/**
    459465 * Output the members pagination count.
     466 *
     467 * @since 1.2.0
    460468 */
    461469function bp_members_pagination_count() {
    … …  
    464472        /**
    465473         * Generate the members pagination count.
     474         *
     475         * @since 1.5.0
    466476         *
    467477         * @return string
    … …  
    516526/**
    517527 * Output the members pagination links.
     528 *
     529 * @since 1.2.0
    518530 */
    519531function bp_members_pagination_links() {
    … …  
    523535         * Fetch the members pagination links.
    524536         *
     537         * @since 1.2.0
     538         *
    525539         * @return string
    526540         */
    … …  
    541555 * Output the ID of the current member in the loop.
    542556 *
     557 * @since 1.2.0
     558 *
    543559 * @uses bp_get_member_user_id()
    544560 */
    … …  
    548564        /**
    549565         * Get the ID of the current member in the loop.
     566         *
     567         * @since 1.2.0
    550568         *
    551569         * @return string Member ID.
    … …  
    581599         *
    582600         * @param array $classes Array of custom classes.
    583          *
    584601         * @return string Row class of the member
    585602         */
    … …  
    592609                        $classes[]   = ( $pos_in_loop % 2 ) ? 'even' : 'odd';
    593610
    594                 // If we've only one member in the loop, don't bother with odd and even.
     611                        // If we've only one member in the loop, don't bother with odd and even.
    595612                } else {
    596613                        $classes[] = 'bp-single-member';
    … …  
    639656/**
    640657 * Output nicename of current member in the loop.
     658 *
     659 * @since 1.2.5
    641660 */
    642661function bp_member_user_nicename() {
    … …  
    646665         * Get the nicename of the current member in the loop.
    647666         *
     667         * @since 1.2.5
     668         *
    648669         * @return string Members nicename.
    649670         */
    … …  
    663684/**
    664685 * Output login for current member in the loop.
     686 *
     687 * @since 1.2.5
    665688 */
    666689function bp_member_user_login() {
    … …  
    670693         * Get the login of the current member in the loop.
    671694         *
     695         * @since 1.2.5
     696         *
    672697         * @return string Member's login.
    673698         */
    … …  
    687712/**
    688713 * Output the email address for the current member in the loop.
     714 *
     715 * @since 1.2.5
    689716 */
    690717function bp_member_user_email() {
    … …  
    694721         * Get the email address of the current member in the loop.
    695722         *
     723         * @since 1.2.5
     724         *
    696725         * @return string Member's email address.
    697726         */
    … …  
    712741 * Check whether the current member in the loop is the logged-in user.
    713742 *
     743 * @since 1.2.5
     744 *
    714745 * @return bool
    715746 */
    … …  
    730761 * Output a member's avatar.
    731762 *
     763 * @since 1.2.0
     764 *
    732765 * @see bp_get_member_avatar() for description of arguments.
    733766 *
    … …  
    747780        /**
    748781         * Get a member's avatar.
     782         *
     783         * @since 1.2.0
    749784         *
    750785         * @see bp_core_fetch_avatar() For a description of arguments and
    … …  
    794829/**
    795830 * Output the permalink for the current member in the loop.
     831 *
     832 * @since 1.2.0
    796833 */
    797834function bp_member_permalink() {
    … …  
    801838         * Get the permalink for the current member in the loop.
    802839         *
     840         * @since 1.2.0
     841         *
    803842         * @return string
    804843         */
    … …  
    818857        /**
    819858         * Alias of {@link bp_member_permalink()}.
     859         *
     860         * @since 1.2.0
    820861         */
    821862        function bp_member_link() { echo bp_get_member_permalink(); }
    … …  
    823864        /**
    824865         * Alias of {@link bp_get_member_permalink()}.
     866         *
     867         * @since 1.2.0
    825868         */
    826869        function bp_get_member_link() { return bp_get_member_permalink(); }
    … …  
    828871/**
    829872 * Output display name of current member in the loop.
     873 *
     874 * @since 1.2.0
    830875 */
    831876function bp_member_name() {
    … …  
    847892         * WP users table, in the following order of preference: display_name,
    848893         * user_nicename, user_login.
     894         *
     895         * @since 1.2.0
    849896         *
    850897         * @return string The user's fullname for display.
    … …  
    888935 * Output the current member's last active time.
    889936 *
     937 * @since 1.2.0
     938 *
    890939 * @param array $args See {@link bp_get_member_last_active()}.
    891940 */
    … …  
    895944        /**
    896945         * Return the current member's last active time.
     946         *
     947         * @since 1.2.0
    897948         *
    898949         * @param array $args {
    … …  
    926977                                : bp_core_time_since( $members_template->member->last_activity );
    927978
    928                 // Member has never logged in or been active.
     979                        // Member has never logged in or been active.
    929980                } else {
    930981                        $last_activity = __( 'Never active', 'buddypress' );
    … …  
    945996 * Output the latest update of the current member in the loop.
    946997 *
     998 * @since 1.2.0
     999 *
    9471000 * @param array|string $args Array of arguments for latest update.
    9481001 */
    … …  
    9521005        /**
    9531006         * Get the latest update from the current member in the loop.
     1007         *
     1008         * @since 1.2.0
    9541009         *
    9551010         * @param array|string $args {
    … …  
    10071062 * Output a piece of user profile data.
    10081063 *
     1064 * @since 1.2.0
     1065 *
    10091066 * @see bp_get_member_profile_data() for a description of params.
    10101067 *
    … …  
    10201077         * to fetch profile data cached in the template global. It is also safe
    10211078         * to use outside of the loop.
     1079         *
     1080         * @since 1.2.0
    10221081         *
    10231082         * @param array|string $args {
    … …  
    10881147/**
    10891148 * Output the 'registered [x days ago]' string for the current member.
     1149 *
     1150 * @since 1.2.0
    10901151 */
    10911152function bp_member_registered() {
    … …  
    10951156         * Get the 'registered [x days ago]' string for the current member.
    10961157         *
     1158         * @since 1.2.0
     1159         *
    10971160         * @return string
    10981161         */
    … …  
    11141177/**
    11151178 * Output a random piece of profile data for the current member in the loop.
     1179 *
     1180 * @since 1.2.0
    11161181 */
    11171182function bp_member_random_profile_data() {
    … …  
    11271192/**
    11281193 * Output hidden input for preserving member search params on form submit.
     1194 *
     1195 * @since 1.2.0
    11291196 */
    11301197function bp_member_hidden_fields() {
    … …  
    11461213/**
    11471214 * Output the Members directory search form.
     1215 *
     1216 * @since 1.0.0
    11481217 */
    11491218function bp_directory_members_search_form() {
    … …  
    11741243/**
    11751244 * Output the total member count.
     1245 *
     1246 * @since 1.2.0
    11761247 */
    11771248function bp_total_site_member_count() {
    … …  
    11811252         * Get the total site member count.
    11821253         *
     1254         * @since 1.2.0
     1255         *
    11831256         * @return int
    11841257         */
    … …  
    12081281 * The function will also analyze the current component the user is in, to
    12091282 * determine whether or not to highlight a particular nav item.
     1283 *
     1284 * @since 1.1.0
    12101285 *
    12111286 * @todo Move to a back-compat file?
    … …  
    12531328/**
    12541329 * Render the navigation markup for the displayed user.
     1330 *
     1331 * @since 1.1.0
    12551332 */
    12561333function bp_get_displayed_user_nav() {
    … …  
    13061383 * Output the logged-in user's avatar.
    13071384 *
     1385 * @since 1.1.0
     1386 *
    13081387 * @see bp_get_loggedin_user_avatar() for a description of params.
    13091388 *
    … …  
    13151394        /**
    13161395         * Get the logged-in user's avatar.
     1396         *
     1397         * @since 1.1.0
    13171398         *
    13181399         * @see bp_core_fetch_avatar() For a description of arguments and
    … …  
    13551436 * Output the displayed user's avatar.
    13561437 *
     1438 * @since 1.1.0
     1439 *
    13571440 * @see bp_get_displayed_user_avatar() for a description of params.
    13581441 *
    … …  
    13641447        /**
    13651448         * Get the displayed user's avatar.
     1449         *
     1450         * @since 1.1.0
    13661451         *
    13671452         * @see bp_core_fetch_avatar() For a description of arguments and
    … …  
    14031488/**
    14041489 * Output the email address of the displayed user.
     1490 *
     1491 * @since 1.5.0
    14051492 */
    14061493function bp_displayed_user_email() {
    … …  
    14091496        /**
    14101497         * Get the email address of the displayed user.
     1498         *
     1499         * @since 1.5.0
    14111500         *
    14121501         * @return string
    … …  
    14341523 * Output the "active [x days ago]" string for a user.
    14351524 *
     1525 * @since 1.0.0
     1526 *
    14361527 * @see bp_get_last_activity() for a description of parameters.
    14371528 *
    … …  
    14511542        /**
    14521543         * Get the "active [x days ago]" string for a user.
     1544         *
     1545         * @since 1.5.0
    14531546         *
    14541547         * @param int $user_id ID of the user. Default: displayed user ID.
    … …  
    14741567/**
    14751568 * Output the calculated first name of the displayed or logged-in user.
     1569 *
     1570 * @since 1.2.0
    14761571 */
    14771572function bp_user_firstname() {
    … …  
    14821577         *
    14831578         * Simply takes all the characters before the first space in a name.
     1579         *
     1580         * @since 1.2.0
    14841581         *
    14851582         * @param string|bool $name Full name to use when generating first name.
    … …  
    15131610/**
    15141611 * Output the link for the logged-in user's profile.
     1612 *
     1613 * @since 1.2.4
    15151614 */
    15161615function bp_loggedin_user_link() {
    … …  
    15201619         * Get the link for the logged-in user's profile.
    15211620         *
     1621         * @since 1.0.0
     1622         *
    15221623         * @return string
    15231624         */
    … …  
    15361637/**
    15371638 * Output the link for the displayed user's profile.
     1639 *
     1640 * @since 1.2.4
    15381641 */
    15391642function bp_displayed_user_link() {
    … …  
    15431646         * Get the link for the displayed user's profile.
    15441647         *
     1648         * @since 1.0.0
     1649         *
    15451650         * @return string
    15461651         */
    … …  
    15661671/**
    15671672 * Alias of {@link bp_displayed_user_id()}.
     1673 *
     1674 * @since 1.0.0
    15681675 */
    15691676function bp_current_user_id() { return bp_displayed_user_id(); }
    … …  
    15711678/**
    15721679 * Generate the link for the displayed user's profile.
     1680 *
     1681 * @since 1.0.0
    15731682 *
    15741683 * @return string
    … …  
    15901699 * Generate the link for the logged-in user's profile.
    15911700 *
     1701 * @since 1.0.0
     1702 *
    15921703 * @return string
    15931704 */
    … …  
    16071718/**
    16081719 * Output the displayed user's display name.
     1720 *
     1721 * @since 1.0.0
    16091722 */
    16101723function bp_displayed_user_fullname() {
    … …  
    16141727         * Get the displayed user's display name.
    16151728         *
     1729         * @since 1.2.0
     1730         *
    16161731         * @return string
    16171732         */
    … …  
    16311746        /**
    16321747         * Alias of {@link bp_get_displayed_user_fullname()}.
     1748         *
     1749         * @since 1.0.0
    16331750         */
    16341751        function bp_user_fullname() { echo bp_get_displayed_user_fullname(); }
    … …  
    16371754/**
    16381755 * Output the logged-in user's display name.
     1756 *
     1757 * @since 1.0.0
    16391758 */
    16401759function bp_loggedin_user_fullname() {
    … …  
    16441763         * Get the logged-in user's display name.
    16451764         *
     1765         * @since 1.0.0
     1766         *
    16461767         * @return string
    16471768         */
    … …  
    16611782/**
    16621783 * Output the username of the displayed user.
     1784 *
     1785 * @since 1.2.0
    16631786 */
    16641787function bp_displayed_user_username() {
    … …  
    16671790        /**
    16681791         * Get the username of the displayed user.
     1792         *
     1793         * @since 1.2.0
    16691794         *
    16701795         * @return string
    … …  
    16911816/**
    16921817 * Output the username of the logged-in user.
     1818 *
     1819 * @since 1.2.0
    16931820 */
    16941821function bp_loggedin_user_username() {
    … …  
    16971824        /**
    16981825         * Get the username of the logged-in user.
     1826         *
     1827         * @since 1.2.0
    16991828         *
    17001829         * @return string
    … …  
    17381867                $message = sprintf( __( 'Viewing members of the type: %s', 'buddypress' ), '<strong>' . $type_object->labels['singular_name'] . '</strong>' );
    17391868
     1869                /**
     1870                 * Filters the current member type message.
     1871                 *
     1872                 * @since 2.3.0
     1873                 *
     1874                 * @param string $message Message to filter.
     1875                 */
    17401876                return apply_filters( 'bp_get_current_member_type_message', $message );
    17411877        }
    … …  
    17641900/**
    17651901 * Output the URL to the signup page.
     1902 *
     1903 * @since 1.0.0
    17661904 */
    17671905function bp_signup_page() {
    … …  
    17701908        /**
    17711909         * Get the URL to the signup page.
     1910         *
     1911         * @since 1.1.0
    17721912         *
    17731913         * @return string
    … …  
    17971937 * @uses bp_get_activate_slug() To make sure there is a slug assigned to the page.
    17981938 * @uses bp_locate_template() To make sure a template exists to provide output.
     1939 *
    17991940 * @return boolean True if page and template exist, false if not.
    18001941 */
    … …  
    18101951/**
    18111952 * Output the URL of the activation page.
     1953 *
     1954 * @since 1.0.0
    18121955 */
    18131956function bp_activation_page() {
    … …  
    18161959        /**
    18171960         * Get the URL of the activation page.
     1961         *
     1962         * @since 1.2.0
    18181963         *
    18191964         * @return string
    … …  
    18381983/**
    18391984 * Output the username submitted during signup.
     1985 *
     1986 * @since 1.1.0
    18401987 */
    18411988function bp_signup_username_value() {
    … …  
    18441991        /**
    18451992         * Get the username submitted during signup.
     1993         *
     1994         * @since 1.1.0
    18461995         *
    18471996         * @todo This should be properly escaped.
    … …  
    18662015/**
    18672016 * Output the user email address submitted during signup.
     2017 *
     2018 * @since 1.1.0
    18682019 */
    18692020function bp_signup_email_value() {
    … …  
    18722023        /**
    18732024         * Get the email address submitted during signup.
     2025         *
     2026         * @since 1.1.0
    18742027         *
    18752028         * @todo This should be properly escaped.
    … …  
    18942047/**
    18952048 * Output the 'signup_with_blog' value submitted during signup.
     2049 *
     2050 * @since 1.1.0
    18962051 */
    18972052function bp_signup_with_blog_value() {
    … …  
    19002055        /**
    19012056         * Get the 'signup_with_blog' value submitted during signup.
     2057         *
     2058         * @since 1.1.0
    19022059         *
    19032060         * @return string
    … …  
    19202077/**
    19212078 * Output the 'signup_blog_url' value submitted at signup.
     2079 *
     2080 * @since 1.1.0
    19222081 */
    19232082function bp_signup_blog_url_value() {
    … …  
    19262085        /**
    19272086         * Get the 'signup_blog_url' value submitted at signup.
     2087         *
     2088         * @since 1.1.0
    19282089         *
    19292090         * @todo Should be properly escaped.
    … …  
    19822143/**
    19832144 * Output the 'signup_blog_titl' value submitted at signup.
     2145 *
     2146 * @since 1.1.0
    19842147 */
    19852148function bp_signup_blog_title_value() {
    … …  
    19882151        /**
    19892152         * Get the 'signup_blog_title' value submitted at signup.
     2153         *
     2154         * @since 1.1.0
    19902155         *
    19912156         * @todo Should be properly escaped.
    … …  
    20102175/**
    20112176 * Output the 'signup_blog_privacy' value submitted at signup.
     2177 *
     2178 * @since 1.1.0
    20122179 */
    20132180function bp_signup_blog_privacy_value() {
    … …  
    20162183        /**
    20172184         * Get the 'signup_blog_privacy' value submitted at signup.
     2185         *
     2186         * @since 1.1.0
    20182187         *
    20192188         * @todo Should be properly escaped.
    … …  
    20382207/**
    20392208 * Output the avatar dir used during signup.
     2209 *
     2210 * @since 1.1.0
    20402211 */
    20412212function bp_signup_avatar_dir_value() {
    … …  
    20442215        /**
    20452216         * Get the avatar dir used during signup.
     2217         *
     2218         * @since 1.1.0
    20462219         *
    20472220         * @return string
    … …  
    20742247/**
    20752248 * Output the current signup step.
     2249 *
     2250 * @since 1.1.0
    20762251 */
    20772252function bp_current_signup_step() {
    … …  
    20812256         * Get the current signup step.
    20822257         *
     2258         * @since 1.1.0
     2259         *
    20832260         * @return string
    20842261         */
    … …  
    20902267 * Output the user avatar during signup.
    20912268 *
     2269 * @since 1.1.0
     2270 *
    20922271 * @see bp_get_signup_avatar() for description of arguments.
    20932272 *
    … …  
    20992278        /**
    21002279         * Get the user avatar during signup.
     2280         *
     2281         * @since 1.1.0
    21012282         *
    21022283         * @see bp_core_fetch_avatar() for description of arguments.
    … …  
    21362317                        ) );
    21372318
    2138                 // No avatar DIR was found.
     2319                        // No avatar DIR was found.
    21392320                } else {
    21402321
    … …  
    21732354 * Output whether signup is allowed.
    21742355 *
     2356 * @since 1.1.0
     2357 *
    21752358 * @todo Remove this function. Echoing a bool is pointless.
    21762359 */
    … …  
    21802363        /**
    21812364         * Is user signup allowed?
     2365         *
     2366         * @since 1.1.0
    21822367         *
    21832368         * @return bool
    … …  
    22292414 * Output a link to a members component subpage.
    22302415 *
     2416 * @since 1.5.0
     2417 *
    22312418 * @see bp_get_members_component_link() for description of parameters.
    22322419 *
    … …  
    22412428        /**
    22422429         * Generate a link to a members component subpage.
     2430         *
     2431         * @since 1.5.0
    22432432         *
    22442433         * @param string       $component  ID of the component (eg 'friends').

  • trunk/src/bp-members/classes/class-bp-core-members-template.php

    r10521 r10711  
    1414 *
    1515 * Responsible for loading a group of members into a loop for display.
     16 *
     17 * @since 1.0.0
    1618 */
    1719class BP_Core_Members_Template {
    … …  
    2022         * The loop iterator.
    2123         *
     24         * @since 1.0.0
    2225         * @var int
    2326         */
    … …  
    2730         * The number of members returned by the paged query.
    2831         *
     32         * @since 1.0.0
    2933         * @var int
    3034         */
    … …  
    3438         * Array of members located by the query.
    3539         *
     40         * @since 1.0.0
    3641         * @var array
    3742         */
    … …  
    4146         * The member object currently being iterated on.
    4247         *
     48         * @since 1.0.0
    4349         * @var object
    4450         */
    … …  
    4854         * A flag for whether the loop is currently being iterated.
    4955         *
     56         * @since 1.0.0
    5057         * @var bool
    5158         */
    … …  
    5562         * The type of member being requested. Used for ordering results.
    5663         *
     64         * @since 2.3.0
    5765         * @var string
    5866         */
    … …  
    6270         * The unique string used for pagination queries.
    6371         *
     72         * @since 2.2.0
    6473         * @var string
    6574         */
    … …  
    6978         * The page number being requested.
    7079         *
     80         * @since 1.0.0
    7181         * @var string
    7282         */
    … …  
    7686         * The number of items being requested per page.
    7787         *
     88         * @since 1.0.0
    7889         * @var string
    7990         */
    … …  
    8394         * An HTML string containing pagination links.
    8495         *
     96         * @since 1.0.0
    8597         * @var string
    8698         */
    … …  
    90102         * The total number of members matching the query parameters.
    91103         *
     104         * @since 1.0.0
    92105         * @var int
    93106         */
    … …  
    96109        /**
    97110         * Constructor method.
     111         *
     112         * @since 1.5.0
    98113         *
    99114         * @see BP_User_Query for an in-depth description of parameters.
    … …  
    185200         * Whether there are members available in the loop.
    186201         *
     202         * @since 1.0.0
     203         *
    187204         * @see bp_has_members()
    188205         *
    … …  
    199216         * Set up the next member and iterate index.
    200217         *
     218         * @since 1.0.0
     219         *
    201220         * @return object The next member to iterate over.
    202221         */
    … …  
    210229        /**
    211230         * Rewind the members and reset member index.
     231         *
     232         * @since 1.0.0
    212233         */
    213234        function rewind_members() {
    … …  
    224245         * that controls iteration inside the members loop, eg:
    225246         *     while ( bp_members() ) { ...
     247         *
     248         * @since 1.2.0
    226249         *
    227250         * @see bp_members()
    … …  
    255278         * reference to the current member.
    256279         *
     280         * @since 1.0.0
     281         *
    257282         * @see bp_the_member()
    258283         */

  • trunk/src/bp-members/classes/class-bp-core-members-widget.php

    r10553 r10711  
    2020        /**
    2121         * Constructor method.
     22         *
     23         * @since 1.5.0
    2224         */
    2325        public function __construct() {
    … …  
    4143        /**
    4244         * Display the Members widget.
     45         *
     46         * @since 1.0.3
    4347         *
    4448         * @see WP_Widget::widget() for description of parameters.
    … …  
    160164         * Update the Members widget options.
    161165         *
     166         * @since 1.0.3
     167         *
    162168         * @param array $new_instance The new instance options.
    163169         * @param array $old_instance The old instance options.
    … …  
    178184         * Output the Members widget options form.
    179185         *
     186         * @since 1.0.3
     187         *
    180188         * @param array $instance Widget instance settings.
    181          *
    182189         * @return void
    183190         */

  • trunk/src/bp-members/classes/class-bp-core-recently-active-widget.php

    r10553 r10711  
    2020        /**
    2121         * Constructor method.
     22         *
     23         * @since 1.5.0
    2224         */
    2325        public function __construct() {
    … …  
    3234        /**
    3335         * Display the Recently Active widget.
     36         *
     37         * @since 1.0.3
    3438         *
    3539         * @see WP_Widget::widget() for description of parameters.
    … …  
    107111         * Update the Recently Active widget options.
    108112         *
     113         * @since 1.0.3
     114         *
    109115         * @param array $new_instance The new instance options.
    110116         * @param array $old_instance The old instance options.
    … …  
    121127        /**
    122128         * Output the Recently Active widget options form.
     129         *
     130         * @since 1.0.3
    123131         *
    124132         * @param array $instance Widget instance settings.

  • trunk/src/bp-members/classes/class-bp-core-whos-online-widget.php

    r10553 r10711  
    2020        /**
    2121         * Constructor method.
     22         *
     23         * @since 1.5.0
    2224         */
    2325        public function __construct() {
    … …  
    3234        /**
    3335         * Display the Who's Online widget.
     36         *
     37         * @since 1.0.3
    3438         *
    3539         * @see WP_Widget::widget() for description of parameters.
    … …  
    107111         * Update the Who's Online widget options.
    108112         *
     113         * @since 1.0.3
     114         *
    109115         * @param array $new_instance The new instance options.
    110116         * @param array $old_instance The old instance options.
    … …  
    121127        /**
    122128         * Output the Who's Online widget options form.
     129         *
     130         * @since 1.0.3
    123131         *
    124132         * @param array $instance Widget instance settings.

  • trunk/src/bp-members/classes/class-bp-members-component.php

    r10652 r10711  
    1313/**
    1414 * Defines the BuddyPress Members Component.
     15 *
     16 * @since 1.5.0
    1517 */
    1618class BP_Members_Component extends BP_Component {
    … …  
    4547        /**
    4648         * Include bp-members files.
     49         *
     50         * @since 1.5.0
    4751         *
    4852         * @see BP_Component::includes() for description of parameters.
    … …  
    114118                        'global_tables'   => array(
    115119                                'table_name_last_activity' => bp_core_get_table_prefix() . 'bp_activity',
    116                                 'table_name_signups'       => $wpdb->base_prefix . 'signups', // signups is a global WordPress table
     120                                'table_name_signups'       => $wpdb->base_prefix . 'signups', // Signups is a global WordPress table.
    117121                        )
    118122                );
    … …  
    283287        /**
    284288         * Set up the title for pages and <title>.
     289         *
     290         * @since 1.5.0
    285291         */
    286292        public function setup_title() {

  • trunk/src/bp-members/classes/class-bp-members-list-table.php

    r10579 r10711  
    9494                global $role;
    9595
    96                 // Used to reset the role
     96                // Used to reset the role.
    9797                $reset_role = $role;
    9898
    99                 // Temporarly set the role to registered
     99                // Temporarly set the role to registered.
    100100                $role = 'registered';
    101101
    102                 // Used to reset the screen id once views are displayed
     102                // Used to reset the screen id once views are displayed.
    103103                $reset_screen_id = $this->screen->id;
    104104
    105                 // Temporarly set the screen id to the users one
     105                // Temporarly set the screen id to the users one.
    106106                $this->screen->id = 'users';
    107107
    108                 // Use the parent function so that other plugins can safely add views
     108                // Use the parent function so that other plugins can safely add views.
    109109                parent::views();
    110110
    111                 // Reset the role
     111                // Reset the role.
    112112                $role = $reset_role;
    113113
    114                 // Reset the screen id
     114                // Reset the screen id.
    115115                $this->screen->id = $reset_screen_id;
    116116        }

  • trunk/src/bp-members/classes/class-bp-members-ms-list-table.php

    r10579 r10711  
    9595                global $role;
    9696
    97                 // Used to reset the role
     97                // Used to reset the role.
    9898                $reset_role = $role;
    9999
    100                 // Temporarly set the role to registered
     100                // Temporarly set the role to registered.
    101101                $role = 'registered';
    102102
    103                 // Used to reset the screen id once views are displayed
     103                // Used to reset the screen id once views are displayed.
    104104                $reset_screen_id = $this->screen->id;
    105105
    106                 // Temporarly set the screen id to the users one
     106                // Temporarly set the screen id to the users one.
    107107                $this->screen->id = 'users-network';
    108108
    109                 // Use the parent function so that other plugins can safely add views
     109                // Use the parent function so that other plugins can safely add views.
    110110                parent::views();
    111111
    112                 // Reset the role
     112                // Reset the role.
    113113                $role = $reset_role;
    114114
    115                 // Reset the screen id
     115                // Reset the screen id.
    116116                $this->screen->id = $reset_screen_id;
    117117        }

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

    r10597 r10711  
    1010/**
    1111 * Class used to handle Signups.
     12 *
     13 * @since 2.0.0
    1214 */
    1315class BP_Signup {
    … …  
    1618         * ID of the signup which the object relates to.
    1719         *
     20         * @since 2.0.0
    1821         * @var integer
    1922         */
    … …  
    2326         * The URL to the full size of the avatar for the user.
    2427         *
     28         * @since 2.0.0
    2529         * @var string
    2630         */
    … …  
    3034         * The username for the user.
    3135         *
     36         * @since 2.0.0
    3237         * @var string
    3338         */
    … …  
    3742         * The email for the user.
    3843         *
     44         * @since 2.0.0
    3945         * @var string
    4046         */
    … …  
    4450         * The full name of the user.
    4551         *
     52         * @since 2.0.0
    4653         * @var string
    4754         */
    … …  
    5158         * Metadata associated with the signup.
    5259         *
     60         * @since 2.0.0
    5361         * @var array
    5462         */
    … …  
    5866         * The registered date for the user.
    5967         *
     68         * @since 2.0.0
    6069         * @var string
    6170         */
    … …  
    6574         * The activation key for the user.
    6675         *
     76         * @since 2.0.0
    6777         * @var string
    6878         */
Note: See TracChangeset for help on using the changeset viewer.