Skip to:
Content

BuddyPress.org

Changeset 9272


Ignore:
Timestamp:
12/24/2014 02:32:14 AM (10 years ago)
Author:
tw2113
Message:

Add hook documentation in bp-members-template.php.

Props tw2113.
Fixes #5944.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r9260 r9272  
    3131     */
    3232    function bp_get_members_slug() {
     33
     34        /**
     35         * Filters the Members component slug.
     36         *
     37         * @since BuddyPress (1.5.0)
     38         *
     39         * @param string $slug Members component slug.
     40         */
    3341        return apply_filters( 'bp_get_members_slug', buddypress()->members->slug );
    3442    }
    … …  
    5260     */
    5361    function bp_get_members_root_slug() {
     62
     63        /**
     64         * Filters the Members component root slug.
     65         *
     66         * @since BuddyPress (1.5.0)
     67         *
     68         * @param string $slug Members component root slug.
     69         */
    5470        return apply_filters( 'bp_get_members_root_slug', buddypress()->members->root_slug );
    5571    }
    … …  
    7389     */
    7490    function bp_get_members_directory_permalink() {
     91
     92        /**
     93         * Filters the member directory permalink.
     94         *
     95         * @since BuddyPress (1.5.0)
     96         *
     97         * @param string $value Members directory permalink.
     98         */
    7599        return apply_filters( 'bp_get_members_directory_permalink', trailingslashit( bp_get_root_domain() . '/' . bp_get_members_root_slug() ) );
    76100    }
    … …  
    104128        }
    105129
     130        /**
     131         * Filters the sign-up slug.
     132         *
     133         * @since BuddyPress (1.5.0)
     134         *
     135         * @param string $slug Sign-up slug.
     136         */
    106137        return apply_filters( 'bp_get_signup_slug', $slug );
    107138    }
    … …  
    135166        }
    136167
     168        /**
     169         * Filters the activation slug.
     170         *
     171         * @since BuddyPress (1.5.0)
     172         *
     173         * @param string $slug Activation slug.
     174         */
    137175        return apply_filters( 'bp_get_activate_slug', $slug );
    138176    }
    … …  
    351389            return true;
    352390        } elseif ( $this->current_member + 1 == $this->member_count ) {
     391
     392            /**
     393             * Fires right before the rewinding of members listing.
     394             *
     395             * @since BuddyPress (1.5.0)
     396             */
    353397            do_action('member_loop_end');
    354398            // Do some cleaning up after the loop
    … …  
    375419
    376420        // loop has just started
    377         if ( 0 == $this->current_member )
     421        if ( 0 == $this->current_member ) {
     422
     423            /**
     424             * Fires if the current member is the first in the loop.
     425             *
     426             * @since BuddyPress (1.5.0)
     427             */
    378428            do_action( 'member_loop_start' );
     429        }
     430
    379431    }
    380432}
    … …  
    500552    );
    501553
     554    /**
     555     * Filters whether or not BuddyPress has members to iterate over.
     556     *
     557     * @since BuddyPress (1.2.4)
     558     *
     559     * @param bool  $value            Whether or not there are members to iterate over.
     560     * @param array $members_template Populated $members_template global.
     561     */
    502562    return apply_filters( 'bp_has_members', $members_template->has_members(), $members_template );
    503563}
    … …  
    554614            $pag = sprintf( _n( 'Viewing 1 member', 'Viewing %1$s - %2$s of %3$s members', $members_template->total_member_count, 'buddypress' ), $from_num, $to_num, $total );
    555615
     616        /**
     617         * Filters the members pagination count.
     618         *
     619         * @since BuddyPress (1.5.0)
     620         *
     621         * @param string $pag Pagination count string.
     622         */
    556623        return apply_filters( 'bp_members_pagination_count', $pag );
    557624    }
    … …  
    571638        global $members_template;
    572639
     640        /**
     641         * Filters the members pagination link.
     642         *
     643         * @since BuddyPress (1.2.0)
     644         *
     645         * @param string $pag_links HTML markup for pagination links.
     646         */
    573647        return apply_filters( 'bp_get_members_pagination_links', $members_template->pag_links );
    574648    }
    … …  
    590664        global $members_template;
    591665        $member_id = isset( $members_template->member->id ) ? (int) $members_template->member->id : false;
     666
     667        /**
     668         * Filters the ID of the current member in the loop.
     669         *
     670         * @since BuddyPress (1.2.0)
     671         *
     672         * @param int $member_id ID of the member being iterated over.
     673         */
    592674        return apply_filters( 'bp_get_member_user_id', $member_id );
    593675    }
    … …  
    627709        }
    628710
     711        /**
     712         * Filters the determined classes to add to the HTML element.
     713         *
     714         * @since BuddyPress (1.7.0)
     715         *
     716         * @param string $classes Classes to be added to the HTML element.
     717         */
    629718        $classes = apply_filters( 'bp_get_member_class', $classes );
    630719        $classes = array_merge( $classes, array() );
    … …  
    647736    function bp_get_member_user_nicename() {
    648737        global $members_template;
     738
     739        /**
     740         * Filters the nicename of the current member in the loop.
     741         *
     742         * @since BuddyPress (1.2.5)
     743         *
     744         * @param string $user_nicename Nicename for the current member.
     745         */
    649746        return apply_filters( 'bp_get_member_user_nicename', $members_template->member->user_nicename );
    650747    }
    … …  
    663760    function bp_get_member_user_login() {
    664761        global $members_template;
     762
     763        /**
     764         * Filters the login of the current member in the loop.
     765         *
     766         * @since BuddyPress (1.2.5)
     767         *
     768         * @param string $user_login Login for the current member.
     769         */
    665770        return apply_filters( 'bp_get_member_user_login', $members_template->member->user_login );
    666771    }
    … …  
    679784    function bp_get_member_user_email() {
    680785        global $members_template;
     786
     787        /**
     788         * Filters the email address of the current member in the loop.
     789         *
     790         * @since BuddyPress (1.2.5)
     791         *
     792         * @param string $user_email Email addres for the current member.
     793         */
    681794        return apply_filters( 'bp_get_member_user_email', $members_template->member->user_email );
    682795    }
    … …  
    689802function bp_member_is_loggedin_user() {
    690803    global $members_template;
     804
     805    /**
     806     * Filters whether the current member in the loop is the logged-in user.
     807     *
     808     * @since BuddyPress (1.2.5)
     809     *
     810     * @param bool $value Whether current member in the loop is logged in.
     811     */
    691812    return apply_filters( 'bp_member_is_loggedin_user', bp_loggedin_user_id() == $members_template->member->id ? true : false );
    692813}
    … …  
    700821 */
    701822function bp_member_avatar( $args = '' ) {
     823
     824    /**
     825     * Filters a members avatar.
     826     *
     827     * @since BuddyPress (1.2.0)
     828     *
     829     * @param string $value Formatted HTML <img> element,
     830     *                      or raw avatar URL based on $html arg
     831     */
    702832    echo apply_filters( 'bp_member_avatar', bp_get_member_avatar( $args ) );
    703833}
    … …  
    739869        extract( $r, EXTR_SKIP );
    740870
     871        /**
     872         * Filters a members avatar.
     873         *
     874         * @since BuddyPress (1.2.0)
     875         *
     876         * @param string $value Formatted HTML <img> element,
     877         *                      or raw avatar URL based on $html arg
     878         */
    741879        return apply_filters( 'bp_get_member_avatar', bp_core_fetch_avatar( array( 'item_id' => $members_template->member->id, 'type' => $type, 'alt' => $alt, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'email' => $members_template->member->user_email ) ) );
    742880    }
    … …  
    756894        global $members_template;
    757895
     896        /**
     897         * Filters the permalink for the current member in the loop.
     898         *
     899         * @since BuddyPress (1.2.0)
     900         *
     901         * @param string $value Permalink for the current member in the loop.
     902         */
    758903        return apply_filters( 'bp_get_member_permalink', bp_core_get_user_domain( $members_template->member->id, $members_template->member->user_nicename, $members_template->member->user_login ) );
    759904    }
    … …  
    773918 */
    774919function bp_member_name() {
     920
     921    /**
     922     * Filters the display name of current member in the loop.
     923     *
     924     * @since BuddyPress (1.2.0)
     925     *
     926     * @param string $value Display name for current member.
     927     */
    775928    echo apply_filters( 'bp_member_name', bp_get_member_name() );
    776929}
    … …  
    807960        }
    808961
     962        /**
     963         * Filters the display name of current member in the loop.
     964         *
     965         * @since BuddyPress (1.2.0)
     966         *
     967         * @param string $fullname Display name for current member.
     968         */
    809969        return apply_filters( 'bp_get_member_name', $members_template->member->fullname );
    810970    }
    … …  
    8591019        }
    8601020
    861         // Filter and return
     1021        /**
     1022         * Filters the current members last active time.
     1023         *
     1024         * @since BuddyPress (1.2.0)
     1025         *
     1026         * @param string $last_activity Formatted time since last activity.
     1027         * @param array  $r             Array of parsed arguments for query.
     1028         */
    8621029        return apply_filters( 'bp_member_last_active', $last_activity, $r );
    8631030    }
    … …  
    8941061            return false;
    8951062
     1063        /**
     1064         * Filters the excerpt of the latest update for current member in the loop.
     1065         *
     1066         * @since BuddyPress (1.2.5)
     1067         *
     1068         * @param string $value Excerpt of the latest update for current member in the loop.
     1069         */
    8961070        $update_content = apply_filters( 'bp_get_activity_latest_update_excerpt', trim( strip_tags( bp_create_excerpt( $update['content'], $length ) ) ) );
    8971071
    … …  
    9061080        }
    9071081
     1082        /**
     1083         * Filters the latest update from the current member in the loop.
     1084         *
     1085         * @since BuddyPress (1.2.0)
     1086         *
     1087         * @param string $update_content Formatted latest update for current member.
     1088         */
    9081089        return apply_filters( 'bp_get_member_latest_update', $update_content );
    9091090    }
    … …  
    9811162        }
    9821163
     1164        /**
     1165         * Filters resulting piece of member profile data.
     1166         *
     1167         * @since BuddyPress (1.2.0)
     1168         *
     1169         * @param string|bool $data Profile data if found, otherwise false.
     1170         */
    9831171        return apply_filters( 'bp_get_member_profile_data', $data );
    9841172    }
    … …  
    10001188        $registered = esc_attr( bp_core_get_last_activity( $members_template->member->user_registered, _x( 'registered %s', 'Records the timestamp that the user registered into the activy stream', 'buddypress' ) ) );
    10011189
     1190        /**
     1191         * Filters the 'registered [x days ago]' string for the current member.
     1192         *
     1193         * @since BuddyPress (2.1.0)
     1194         *
     1195         * @param string $registered The 'registered [x days ago]' string.
     1196         */
    10021197        return apply_filters( 'bp_member_registered', $registered );
    10031198    }
    … …  
    10431238    </form>';
    10441239
     1240    /**
     1241     * Filters the Members component search form.
     1242     *
     1243     * @since BuddyPress (1.9.0)
     1244     *
     1245     * @param string $search_form_html HTML markup for the member search form.
     1246     */
    10451247    echo apply_filters( 'bp_directory_members_search_form', $search_form_html );
    10461248}
    … …  
    10581260     */
    10591261    function bp_get_total_site_member_count() {
     1262
     1263        /**
     1264         * Filters the total site member count.
     1265         *
     1266         * @since BuddyPress (1.2.0)
     1267         *
     1268         * @param int $value Number-formatted total site member count.
     1269         */
    10601270        return apply_filters( 'bp_get_total_site_member_count', bp_core_number_format( bp_core_get_total_member_count() ) );
    10611271    }
    … …  
    11381348        }
    11391349
     1350        /**
     1351         * Filters the navigation markup for the displayed user.
     1352         *
     1353         * This is a dynamic filter that is dependent on the navigation tab component being rendered.
     1354         *
     1355         * @since BuddyPress (1.1.0)
     1356         *
     1357         * @param string $value         Markup for the tab list item including link.
     1358         * @param array  $user_nav_item Array holding parts used to construct tab list item.
     1359         *                              Passed by reference.
     1360         */
    11401361        echo apply_filters_ref_array( 'bp_get_displayed_user_nav_' . $user_nav_item['css_id'], array( '<li id="' . $user_nav_item['css_id'] . '-personal-li" ' . $selected . '><a id="user-' . $user_nav_item['css_id'] . '" href="' . $link . '">' . $user_nav_item['name'] . '</a></li>', &$user_nav_item ) );
    11411362    }
    … …  
    11831404        extract( $r, EXTR_SKIP );
    11841405
     1406        /**
     1407         * Filters the logged in user's avatar.
     1408         *
     1409         * @since BuddyPress (1.1.0)
     1410         *
     1411         * @param string $value User avatar string.
     1412         */
    11851413        return apply_filters( 'bp_get_loggedin_user_avatar', bp_core_fetch_avatar( array( 'item_id' => bp_loggedin_user_id(), 'type' => $type, 'width' => $width, 'height' => $height, 'html' => $html, 'alt' => $alt ) ) );
    11861414    }
    … …  
    12251453        extract( $r, EXTR_SKIP );
    12261454
     1455        /**
     1456         * Filters the displayed user's avatar.
     1457         *
     1458         * @since BuddyPress (1.1.0)
     1459         *
     1460         * @param string $value User avatar string.
     1461         */
    12271462        return apply_filters( 'bp_get_displayed_user_avatar', bp_core_fetch_avatar( array( 'item_id' => bp_displayed_user_id(), 'type' => $type, 'width' => $width, 'height' => $height, 'html' => $html, 'alt' => $alt ) ) );
    12281463    }
    … …  
    12481483            $retval = '';
    12491484
     1485        /**
     1486         * Filters the email address of the displayed user.
     1487         *
     1488         * @since BuddyPress (1.5.0)
     1489         *
     1490         * @param string $retval Email address for displayed user.
     1491         */
    12501492        return apply_filters( 'bp_get_displayed_user_email', esc_attr( $retval ) );
    12511493    }
    … …  
    12591501 */
    12601502function bp_last_activity( $user_id = 0 ) {
     1503
     1504    /**
     1505     * Filters the 'active [x days ago]' string for a user.
     1506     *
     1507     * @since BuddyPress (1.0.0)
     1508     *
     1509     * @param string $value Formatted 'active [x days ago]' string.
     1510     */
    12611511    echo apply_filters( 'bp_last_activity', bp_get_last_activity( $user_id ) );
    12621512}
    … …  
    12741524        $last_activity = bp_core_get_last_activity( bp_get_user_last_activity( $user_id ), __('active %s', 'buddypress') );
    12751525
     1526        /**
     1527         * Filters the 'active [x days ago]' string for a user.
     1528         *
     1529         * @since BuddyPress (1.5.0)
     1530         *
     1531         * @param string $value Formatted 'active [x days ago]' string.
     1532         */
    12761533        return apply_filters( 'bp_get_last_activity', $last_activity );
    12771534    }
    … …  
    13051562        $fullname = (array) explode( ' ', $name );
    13061563
     1564        /**
     1565         * Filters the first name of a user.
     1566         *
     1567         * @since BuddyPress (1.2.0)
     1568         *
     1569         * @param string $value    First name of user.
     1570         * @param string $fullname Full name of user.
     1571         */
    13071572        return apply_filters( 'bp_get_user_firstname', $fullname[0], $fullname );
    13081573    }
    … …  
    13201585     */
    13211586    function bp_get_loggedin_user_link() {
     1587
     1588        /**
     1589         * Filters the link for the logged-in user's profile.
     1590         *
     1591         * @since BuddyPress (1.2.4)
     1592         *
     1593         * @param string $value Link for the logged-in user's profile.
     1594         */
    13221595        return apply_filters( 'bp_get_loggedin_user_link', bp_loggedin_user_domain() );
    13231596    }
    … …  
    13351608     */
    13361609    function bp_get_displayed_user_link() {
     1610
     1611        /**
     1612         * Filters the link for the displayed user's profile.
     1613         *
     1614         * @since BuddyPress (1.2.4)
     1615         *
     1616         * @param string $value Link for the displayed user's profile.
     1617         */
    13371618        return apply_filters( 'bp_get_displayed_user_link', bp_displayed_user_domain() );
    13381619    }
    … …  
    13571638function bp_displayed_user_domain() {
    13581639    global $bp;
     1640
     1641    /**
     1642     * Filters the generated link for the displayed user's profile.
     1643     *
     1644     * @since BuddyPress (1.0.0)
     1645     *
     1646     * @param string $value Generated link for the displayed user's profile.
     1647     */
    13591648    return apply_filters( 'bp_displayed_user_domain', isset( $bp->displayed_user->domain ) ? $bp->displayed_user->domain : '' );
    13601649}
    … …  
    13671656function bp_loggedin_user_domain() {
    13681657    global $bp;
     1658
     1659    /**
     1660     * Filters the generated link for the logged-in user's profile.
     1661     *
     1662     * @since BuddyPress (1.0.0)
     1663     *
     1664     * @param string $value Generated link for the logged-in user's profile.
     1665     */
    13691666    return apply_filters( 'bp_loggedin_user_domain', isset( $bp->loggedin_user->domain ) ? $bp->loggedin_user->domain : '' );
    13701667}
    … …  
    13831680    function bp_get_displayed_user_fullname() {
    13841681        global $bp;
     1682
     1683        /**
     1684         * Filters the displayed user's display name.
     1685         *
     1686         * @since BuddyPress (1.2.0)
     1687         *
     1688         * @param string $value Displayed user's display name.
     1689         */
    13851690        return apply_filters( 'bp_displayed_user_fullname', isset( $bp->displayed_user->fullname ) ? $bp->displayed_user->fullname : '' );
    13861691    }
    … …  
    14051710    function bp_get_loggedin_user_fullname() {
    14061711        global $bp;
     1712
     1713        /**
     1714         * Filters the logged-in user's display name.
     1715         *
     1716         * @since BuddyPress (1.0.0)
     1717         *
     1718         * @param string $value Logged-in user's display name.
     1719         */
    14071720        return apply_filters( 'bp_get_loggedin_user_fullname', isset( $bp->loggedin_user->fullname ) ? $bp->loggedin_user->fullname : '' );
    14081721    }
    … …  
    14281741        }
    14291742
     1743        /**
     1744         * Filters the username of the displayed user.
     1745         *
     1746         * @since BuddyPress (1.2.0)
     1747         *
     1748         * @param string $username Username of the displayed user.
     1749         */
    14301750        return apply_filters( 'bp_get_displayed_user_username', $username );
    14311751    }
    … …  
    14511771        }
    14521772
     1773        /**
     1774         * Filters the username of the logged-in user.
     1775         *
     1776         * @since BuddyPress (1.2.0)
     1777         *
     1778         * @param string $username Username of the logged-in user.
     1779         */
    14531780        return apply_filters( 'bp_get_loggedin_user_username', $username );
    14541781    }
    … …  
    14921819        }
    14931820
     1821        /**
     1822         * Filters the URL to the signup page.
     1823         *
     1824         * @since BuddyPress (1.1.0)
     1825         *
     1826         * @param string $page URL to the signup page.
     1827         */
    14941828        return apply_filters( 'bp_get_signup_page', $page );
    14951829    }
    … …  
    15311865        }
    15321866
     1867        /**
     1868         * Filters the URL of the activation page.
     1869         *
     1870         * @since BuddyPress (1.2.0)
     1871         *
     1872         * @param string $page URL to the activation page.
     1873         */
    15331874        return apply_filters( 'bp_get_activation_page', $page );
    15341875    }
    … …  
    15521893            $value = $_POST['signup_username'];
    15531894
     1895        /**
     1896         * Filters the username submitted during signup.
     1897         *
     1898         * @since BuddyPress (1.1.0)
     1899         *
     1900         * @param string $value Username submitted during signup.
     1901         */
    15541902        return apply_filters( 'bp_get_signup_username_value', $value );
    15551903    }
    … …  
    15731921            $value = $_POST['signup_email'];
    15741922
     1923        /**
     1924         * Filters the email address submitted during signup.
     1925         *
     1926         * @since BuddyPress (1.1.0)
     1927         *
     1928         * @param string $value Email address submitted during signup.
     1929         */
    15751930        return apply_filters( 'bp_get_signup_email_value', $value );
    15761931    }
    … …  
    15921947            $value = $_POST['signup_with_blog'];
    15931948
     1949        /**
     1950         * Filters the 'signup_with_blog' value submitted during signup.
     1951         *
     1952         * @since BuddyPress (1.1.0)
     1953         *
     1954         * @param string $value 'signup_with_blog' value submitted during signup.
     1955         */
    15941956        return apply_filters( 'bp_get_signup_with_blog_value', $value );
    15951957    }
    … …  
    16131975            $value = $_POST['signup_blog_url'];
    16141976
     1977        /**
     1978         * Filters the 'signup_blog_url' value submitted during signup.
     1979         *
     1980         * @since BuddyPress (1.1.0)
     1981         *
     1982         * @param string $value 'signup_blog_url' value submitted during signup.
     1983         */
    16151984        return apply_filters( 'bp_get_signup_blog_url_value', $value );
    16161985    }
    … …  
    16392008        $subdomain_base = apply_filters( 'bp_blogs_subdomain_base', preg_replace( '|^www\.|', '', $current_site->domain ) . $current_site->path );
    16402009
     2010        /**
     2011         * Filters the base URL for subdomain installations of WordPress Multisite.
     2012         *
     2013         * @since BuddyPress (2.1.0)
     2014         *
     2015         * @param string $subdomain_base The base URL - eg, 'example.com' for
     2016         *                               site_url() example.com or www.example.com.
     2017         */
    16412018        return apply_filters( 'bp_signup_subdomain_base', $subdomain_base );
    16422019    }
    … …  
    16602037            $value = $_POST['signup_blog_title'];
    16612038
     2039        /**
     2040         * Filters the 'signup_blog_title' value submitted during signup.
     2041         *
     2042         * @since BuddyPress (1.1.0)
     2043         *
     2044         * @param string $value 'signup_blog_title' value submitted during signup.
     2045         */
    16622046        return apply_filters( 'bp_get_signup_blog_title_value', $value );
    16632047    }
    … …  
    16812065            $value = $_POST['signup_blog_privacy'];
    16822066
     2067        /**
     2068         * Filters the 'signup_blog_privacy' value submitted during signup.
     2069         *
     2070         * @since BuddyPress (1.1.0)
     2071         *
     2072         * @param string $value 'signup_blog_privacy' value submitted during signup.
     2073         */
    16832074        return apply_filters( 'bp_get_signup_blog_privacy_value', $value );
    16842075    }
    … …  
    17102101            $signup_avatar_dir = false;
    17112102
     2103        /**
     2104         * Filters the avatar dir used during signup.
     2105         *
     2106         * @since BuddyPress (1.1.0)
     2107         *
     2108         * @param string|bool $signup_avatar_dir Avatar dir used during signup or false.
     2109         */
    17122110        return apply_filters( 'bp_get_signup_avatar_dir_value', $signup_avatar_dir );
    17132111    }
    … …  
    17902188                $default_grav = $bp->grav_default->user;
    17912189
    1792             // Create
     2190            /**
     2191             * Filters the base Gravatar url used for signup avatars when no avatar dir found.
     2192             *
     2193             * @since BuddyPress (1.0.2)
     2194             *
     2195             * @param string $value Gravatar url to use.
     2196             */
    17932197            $gravatar_url    = apply_filters( 'bp_gravatar_url', 'http://www.gravatar.com/avatar/' );
    17942198            $md5_lcase_email = md5( strtolower( bp_get_signup_email_value() ) );
    … …  
    17962200        }
    17972201
     2202        /**
     2203         * Filters the user avatar during signup.
     2204         *
     2205         * @since BuddyPress (1.1.0)
     2206         *
     2207         * @param string $gravatar_img Avatar HTML image tag.
     2208         * @param array  $args         Array of parsed args for avatar query.
     2209         */
    17982210        return apply_filters( 'bp_get_signup_avatar', $gravatar_img, $args );
    17992211    }
    … …  
    18322244        }
    18332245
     2246        /**
     2247         * Filters whether or not new signups are allowed.
     2248         *
     2249         * @since BuddyPress (1.5.0)
     2250         *
     2251         * @param bool $signup_allowed Whether or not new signups are allowed.
     2252         */
    18342253        return apply_filters( 'bp_get_signup_allowed', $signup_allowed );
    18352254    }
Note: See TracChangeset for help on using the changeset viewer.