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/bp-members-template.php

    r10126 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Member Template Tags.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1615 * Output the profile component slug.
    1716 *
    18  * @since BuddyPress (2.4.0)
     17 * @since 2.4.0
    1918 *
    2019 * @uses bp_get_profile_slug()
     
    2625     * Return the profile component slug.
    2726     *
    28      * @since BuddyPress (2.4.0)
     27     * @since 2.4.0
    2928     *
    3029     * @return string
     
    3534         * Filters the profile component slug.
    3635         *
    37          * @since BuddyPress (2.4.0)
     36         * @since 2.4.0
    3837         *
    3938         * @param string $slug Profile component slug.
     
    4544 * Output the members component slug.
    4645 *
    47  * @since BuddyPress (1.5.0)
     46 * @since 1.5.0
    4847 *
    4948 * @uses bp_get_members_slug()
     
    5554     * Return the members component slug.
    5655     *
    57      * @since BuddyPress (1.5.0)
     56     * @since 1.5.0
    5857     *
    5958     * @return string
     
    6463         * Filters the Members component slug.
    6564         *
    66          * @since BuddyPress (1.5.0)
     65         * @since 1.5.0
    6766         *
    6867         * @param string $slug Members component slug.
     
    7473 * Output the members component root slug.
    7574 *
    76  * @since BuddyPress (1.5.0)
     75 * @since 1.5.0
    7776 *
    7877 * @uses bp_get_members_root_slug()
     
    8483     * Return the members component root slug.
    8584     *
    86      * @since BuddyPress (1.5.0)
     85     * @since 1.5.0
    8786     *
    8887     * @return string
     
    9392         * Filters the Members component root slug.
    9493         *
    95          * @since BuddyPress (1.5.0)
     94         * @since 1.5.0
    9695         *
    9796         * @param string $slug Members component root slug.
     
    103102 * Output member directory permalink.
    104103 *
    105  * @since BuddyPress (1.5.0)
     104 * @since 1.5.0
    106105 *
    107106 * @uses bp_get_members_directory_permalink()
     
    113112     * Return member directory permalink.
    114113     *
    115      * @since BuddyPress (1.5.0)
     114     * @since 1.5.0
    116115     *
    117116     * @return string
     
    122121         * Filters the member directory permalink.
    123122         *
    124          * @since BuddyPress (1.5.0)
     123         * @since 1.5.0
    125124         *
    126125         * @param string $value Members directory permalink.
     
    132131 * Output the sign-up slug.
    133132 *
    134  * @since BuddyPress (1.5.0)
     133 * @since 1.5.0
    135134 *
    136135 * @uses bp_get_signup_slug()
     
    142141     * Return the sign-up slug.
    143142     *
    144      * @since BuddyPress (1.5.0)
     143     * @since 1.5.0
    145144     *
    146145     * @return string
     
    160159         * Filters the sign-up slug.
    161160         *
    162          * @since BuddyPress (1.5.0)
     161         * @since 1.5.0
    163162         *
    164163         * @param string $slug Sign-up slug.
     
    170169 * Output the activation slug.
    171170 *
    172  * @since BuddyPress (1.5.0)
     171 * @since 1.5.0
    173172 *
    174173 * @uses bp_get_activate_slug()
     
    180179     * Return the activation slug.
    181180     *
    182      * @since BuddyPress (1.5.0)
     181     * @since 1.5.0
    183182     *
    184183     * @return string
     
    198197         * Filters the activation slug.
    199198         *
    200          * @since BuddyPress (1.5.0)
     199         * @since 1.5.0
    201200         *
    202201         * @param string $slug Activation slug.
     
    442441             * Fires right before the rewinding of members listing.
    443442             *
    444              * @since BuddyPress (1.5.0)
     443             * @since 1.5.0
    445444             */
    446445            do_action('member_loop_end');
     
    473472             * Fires if the current member is the first in the loop.
    474473             *
    475              * @since BuddyPress (1.5.0)
     474             * @since 1.5.0
    476475             */
    477476            do_action( 'member_loop_start' );
     
    631630     * Filters whether or not BuddyPress has members to iterate over.
    632631     *
    633      * @since BuddyPress (1.2.4)
     632     * @since 1.2.4
    634633     *
    635634     * @param bool  $value            Whether or not there are members to iterate over.
     
    710709         * Filters the members pagination count.
    711710         *
    712          * @since BuddyPress (1.5.0)
     711         * @since 1.5.0
    713712         *
    714713         * @param string $pag Pagination count string.
     
    734733         * Filters the members pagination link.
    735734         *
    736          * @since BuddyPress (1.2.0)
     735         * @since 1.2.0
    737736         *
    738737         * @param string $pag_links HTML markup for pagination links.
     
    761760         * Filters the ID of the current member in the loop.
    762761         *
    763          * @since BuddyPress (1.2.0)
     762         * @since 1.2.0
    764763         *
    765764         * @param int $member_id ID of the member being iterated over.
     
    771770 * Output the row class of the current member in the loop.
    772771 *
    773  * @since BuddyPress (1.7.0)
     772 * @since 1.7.0
    774773 *
    775774 * @param array $classes Array of custom classes
     
    781780     * Return the row class of the current member in the loop.
    782781     *
    783      * @since BuddyPress (1.7.0)
     782     * @since 1.7.0
    784783     *
    785784     * @param array $classes Array of custom classes
     
    822821         * Filters the determined classes to add to the HTML element.
    823822         *
    824          * @since BuddyPress (1.7.0)
     823         * @since 1.7.0
    825824         *
    826825         * @param string $classes Classes to be added to the HTML element.
     
    850849         * Filters the nicename of the current member in the loop.
    851850         *
    852          * @since BuddyPress (1.2.5)
     851         * @since 1.2.5
    853852         *
    854853         * @param string $user_nicename Nicename for the current member.
     
    874873         * Filters the login of the current member in the loop.
    875874         *
    876          * @since BuddyPress (1.2.5)
     875         * @since 1.2.5
    877876         *
    878877         * @param string $user_login Login for the current member.
     
    898897         * Filters the email address of the current member in the loop.
    899898         *
    900          * @since BuddyPress (1.2.5)
     899         * @since 1.2.5
    901900         *
    902901         * @param string $user_email Email address for the current member.
     
    916915     * Filters whether the current member in the loop is the logged-in user.
    917916     *
    918      * @since BuddyPress (1.2.5)
     917     * @since 1.2.5
    919918     *
    920919     * @param bool $value Whether current member in the loop is logged in.
     
    935934     * Filters a members avatar.
    936935     *
    937      * @since BuddyPress (1.2.0)
     936     * @since 1.2.0
    938937     *
    939938     * @param string $value Formatted HTML <img> element,
     
    982981         * Filters a members avatar.
    983982         *
    984          * @since BuddyPress (1.2.0)
     983         * @since 1.2.0
    985984         *
    986985         * @param string $value Formatted HTML <img> element,
     
    10071006         * Filters the permalink for the current member in the loop.
    10081007         *
    1009          * @since BuddyPress (1.2.0)
     1008         * @since 1.2.0
    10101009         *
    10111010         * @param string $value Permalink for the current member in the loop.
     
    10321031     * Filters the display name of current member in the loop.
    10331032     *
    1034      * @since BuddyPress (1.2.0)
     1033     * @since 1.2.0
    10351034     *
    10361035     * @param string $value Display name for current member.
     
    10731072         * Filters the display name of current member in the loop.
    10741073         *
    1075          * @since BuddyPress (1.2.0)
     1074         * @since 1.2.0
    10761075         *
    10771076         * @param string $fullname Display name for current member.
     
    11331132         * Filters the current members last active time.
    11341133         *
    1135          * @since BuddyPress (1.2.0)
     1134         * @since 1.2.0
    11361135         *
    11371136         * @param string $last_activity Formatted time since last activity.
     
    11771176         * Filters the excerpt of the latest update for current member in the loop.
    11781177         *
    1179          * @since BuddyPress (1.2.5)
     1178         * @since 1.2.5
    11801179         *
    11811180         * @param string $value Excerpt of the latest update for current member in the loop.
     
    11961195         * Filters the latest update from the current member in the loop.
    11971196         *
    1198          * @since BuddyPress (1.2.0)
     1197         * @since 1.2.0
    11991198         *
    12001199         * @param string $update_content Formatted latest update for current member.
     
    12781277         * Filters resulting piece of member profile data.
    12791278         *
    1280          * @since BuddyPress (1.2.0)
     1279         * @since 1.2.0
    12811280         *
    12821281         * @param string|bool $data Profile data if found, otherwise false.
     
    13041303         * Filters the 'registered [x days ago]' string for the current member.
    13051304         *
    1306          * @since BuddyPress (2.1.0)
     1305         * @since 2.1.0
    13071306         *
    13081307         * @param string $registered The 'registered [x days ago]' string.
     
    13591358     * Filters the Members component search form.
    13601359     *
    1361      * @since BuddyPress (1.9.0)
     1360     * @since 1.9.0
    13621361     *
    13631362     * @param string $search_form_html HTML markup for the member search form.
     
    13821381         * Filters the total site member count.
    13831382         *
    1384          * @since BuddyPress (1.2.0)
     1383         * @since 1.2.0
    13851384         *
    13861385         * @param int $value Number-formatted total site member count.
     
    14711470         * This is a dynamic filter that is dependent on the navigation tab component being rendered.
    14721471         *
    1473          * @since BuddyPress (1.1.0)
     1472         * @since 1.1.0
    14741473         *
    14751474         * @param string $value         Markup for the tab list item including link.
     
    15251524         * Filters the logged in user's avatar.
    15261525         *
    1527          * @since BuddyPress (1.1.0)
     1526         * @since 1.1.0
    15281527         *
    15291528         * @param string $value User avatar string.
     
    15741573         * Filters the displayed user's avatar.
    15751574         *
    1576          * @since BuddyPress (1.1.0)
     1575         * @since 1.1.0
    15771576         *
    15781577         * @param string $value User avatar string.
     
    16041603         * Filters the email address of the displayed user.
    16051604         *
    1606          * @since BuddyPress (1.5.0)
     1605         * @since 1.5.0
    16071606         *
    16081607         * @param string $retval Email address for displayed user.
     
    16231622     * Filters the 'active [x days ago]' string for a user.
    16241623     *
    1625      * @since BuddyPress (1.0.0)
     1624     * @since 1.0.0
    16261625     *
    16271626     * @param string $value Formatted 'active [x days ago]' string.
     
    16461645         * Filters the 'active [x days ago]' string for a user.
    16471646         *
    1648          * @since BuddyPress (1.5.0)
     1647         * @since 1.5.0
    16491648         *
    16501649         * @param string $value Formatted 'active [x days ago]' string.
     
    16841683         * Filters the first name of a user.
    16851684         *
    1686          * @since BuddyPress (1.2.0)
     1685         * @since 1.2.0
    16871686         *
    16881687         * @param string $value    First name of user.
     
    17081707         * Filters the link for the logged-in user's profile.
    17091708         *
    1710          * @since BuddyPress (1.2.4)
     1709         * @since 1.2.4
    17111710         *
    17121711         * @param string $value Link for the logged-in user's profile.
     
    17311730         * Filters the link for the displayed user's profile.
    17321731         *
    1733          * @since BuddyPress (1.2.4)
     1732         * @since 1.2.4
    17341733         *
    17351734         * @param string $value Link for the displayed user's profile.
     
    17611760     * Filters the generated link for the displayed user's profile.
    17621761     *
    1763      * @since BuddyPress (1.0.0)
     1762     * @since 1.0.0
    17641763     *
    17651764     * @param string $value Generated link for the displayed user's profile.
     
    17791778     * Filters the generated link for the logged-in user's profile.
    17801779     *
    1781      * @since BuddyPress (1.0.0)
     1780     * @since 1.0.0
    17821781     *
    17831782     * @param string $value Generated link for the logged-in user's profile.
     
    18031802         * Filters the displayed user's display name.
    18041803         *
    1805          * @since BuddyPress (1.2.0)
     1804         * @since 1.2.0
    18061805         *
    18071806         * @param string $value Displayed user's display name.
     
    18331832         * Filters the logged-in user's display name.
    18341833         *
    1835          * @since BuddyPress (1.0.0)
     1834         * @since 1.0.0
    18361835         *
    18371836         * @param string $value Logged-in user's display name.
     
    18631862         * Filters the username of the displayed user.
    18641863         *
    1865          * @since BuddyPress (1.2.0)
     1864         * @since 1.2.0
    18661865         *
    18671866         * @param string $username Username of the displayed user.
     
    18931892         * Filters the username of the logged-in user.
    18941893         *
    1895          * @since BuddyPress (1.2.0)
     1894         * @since 1.2.0
    18961895         *
    18971896         * @param string $username Username of the logged-in user.
     
    19021901 * Echo the current member type message.
    19031902 *
    1904  * @since BuddyPress (2.3.0)
     1903 * @since 2.3.0
    19051904 */
    19061905function bp_current_member_type_message() {
     
    19101909     * Generate the current member type message.
    19111910     *
    1912      * @since BuddyPress (2.3.0)
     1911     * @since 2.3.0
    19131912     *
    19141913     * @return string
     
    19271926 * Do we have a working custom sign up page?
    19281927 *
    1929  * @since BuddyPress (1.5.0)
     1928 * @since 1.5.0
    19301929 *
    19311930 * @uses bp_get_signup_slug() To make sure there is a slug assigned to the page.
     
    19631962         * Filters the URL to the signup page.
    19641963         *
    1965          * @since BuddyPress (1.1.0)
     1964         * @since 1.1.0
    19661965         *
    19671966         * @param string $page URL to the signup page.
     
    19731972 * Do we have a working custom activation page?
    19741973 *
    1975  * @since BuddyPress (1.5.0)
     1974 * @since 1.5.0
    19761975 *
    19771976 * @uses bp_get_activate_slug() To make sure there is a slug assigned to the page.
     
    20092008         * Filters the URL of the activation page.
    20102009         *
    2011          * @since BuddyPress (1.2.0)
     2010         * @since 1.2.0
    20122011         *
    20132012         * @param string $page URL to the activation page.
     
    20372036         * Filters the username submitted during signup.
    20382037         *
    2039          * @since BuddyPress (1.1.0)
     2038         * @since 1.1.0
    20402039         *
    20412040         * @param string $value Username submitted during signup.
     
    20652064         * Filters the email address submitted during signup.
    20662065         *
    2067          * @since BuddyPress (1.1.0)
     2066         * @since 1.1.0
    20682067         *
    20692068         * @param string $value Email address submitted during signup.
     
    20912090         * Filters the 'signup_with_blog' value submitted during signup.
    20922091         *
    2093          * @since BuddyPress (1.1.0)
     2092         * @since 1.1.0
    20942093         *
    20952094         * @param string $value 'signup_with_blog' value submitted during signup.
     
    21192118         * Filters the 'signup_blog_url' value submitted during signup.
    21202119         *
    2121          * @since BuddyPress (1.1.0)
     2120         * @since 1.1.0
    21222121         *
    21232122         * @param string $value 'signup_blog_url' value submitted during signup.
     
    21292128 * Output the base URL for subdomain installations of WordPress Multisite.
    21302129 *
    2131  * @since BuddyPress (2.1.0)
     2130 * @since 2.1.0
    21322131 */
    21332132function bp_signup_subdomain_base() {
     
    21392138     * Replaces bp_blogs_get_subdomain_base()
    21402139     *
    2141      * @since BuddyPress (2.1.0)
     2140     * @since 2.1.0
    21422141     *
    21432142     * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com.
     
    21522151         * Filters the base URL for subdomain installations of WordPress Multisite.
    21532152         *
    2154          * @since BuddyPress (2.1.0)
     2153         * @since 2.1.0
    21552154         *
    21562155         * @param string $subdomain_base The base URL - eg, 'example.com' for
     
    21812180         * Filters the 'signup_blog_title' value submitted during signup.
    21822181         *
    2183          * @since BuddyPress (1.1.0)
     2182         * @since 1.1.0
    21842183         *
    21852184         * @param string $value 'signup_blog_title' value submitted during signup.
     
    22092208         * Filters the 'signup_blog_privacy' value submitted during signup.
    22102209         *
    2211          * @since BuddyPress (1.1.0)
     2210         * @since 1.1.0
    22122211         *
    22132212         * @param string $value 'signup_blog_privacy' value submitted during signup.
     
    22452244         * Filters the avatar dir used during signup.
    22462245         *
    2247          * @since BuddyPress (1.1.0)
     2246         * @since 1.1.0
    22482247         *
    22492248         * @param string|bool $signup_avatar_dir Avatar dir used during signup or false.
     
    23302329             * Filters the base Gravatar url used for signup avatars when no avatar dir found.
    23312330             *
    2332              * @since BuddyPress (1.0.2)
     2331             * @since 1.0.2
    23332332             *
    23342333             * @param string $value Gravatar url to use.
     
    23422341         * Filters the user avatar during signup.
    23432342         *
    2344          * @since BuddyPress (1.1.0)
     2343         * @since 1.1.0
    23452344         *
    23462345         * @param string $gravatar_img Avatar HTML image tag.
     
    23842383         * Filters whether or not new signups are allowed.
    23852384         *
    2386          * @since BuddyPress (1.5.0)
     2385         * @since 1.5.0
    23872386         *
    23882387         * @param bool $signup_allowed Whether or not new signups are allowed.
     
    23942393 * Hook member activity feed to <head>.
    23952394 *
    2396  * @since BuddyPress (1.5.0)
     2395 * @since 1.5.0
    23972396 */
    23982397function bp_members_activity_feed() {
Note: See TracChangeset for help on using the changeset viewer.