Skip to:
Content

BuddyPress.org

Changeset 9046


Ignore:
Timestamp:
09/27/2014 12:41:29 AM (10 years ago)
Author:
boonebgorges
Message:

Some improvements to inline documentation in bp-groups-template.php

See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-template.php

    r9036 r9046  
    15081508}
    15091509
     1510/**
     1511 * Determine whether the displayed user has no groups.
     1512 *
     1513 * No longer used in BuddyPress.
     1514 *
     1515 * @todo Deprecate
     1516 *
     1517 * @return bool True if the displayed user has no groups, otherwise false.
     1518 */
    15101519function bp_group_show_no_groups_message() {
    15111520    if ( !groups_total_groups_for_user( bp_displayed_user_id() ) )
     
    15151524}
    15161525
     1526/**
     1527 * Determine whether the current page is a group activity permalink.
     1528 *
     1529 * No longer used in BuddyPress.
     1530 *
     1531 * @todo Deprecate.
     1532 *
     1533 * @return bool True if this is a group activity permalink, otherwise false.
     1534 */
    15171535function bp_group_is_activity_permalink() {
    15181536
     
    15231541}
    15241542
     1543/**
     1544 * Output the pagination HTML for a group loop.
     1545 */
    15251546function bp_groups_pagination_links() {
    15261547    echo bp_get_groups_pagination_links();
    15271548}
     1549    /**
     1550     * Get the pagination HTML for a group loop.
     1551     *
     1552     * @return string
     1553     */
    15281554    function bp_get_groups_pagination_links() {
    15291555        global $groups_template;
     
    15321558    }
    15331559
     1560/**
     1561 * Output the "Viewing x-y of z groups" pagination message.
     1562 */
    15341563function bp_groups_pagination_count() {
    15351564    echo bp_get_groups_pagination_count();
    15361565}
     1566    /**
     1567     * Generate the "Viewing x-y of z groups" pagination message.
     1568     *
     1569     * @return string
     1570     */
    15371571    function bp_get_groups_pagination_count() {
    15381572        global $groups_template;
     
    15461580    }
    15471581
     1582/**
     1583 * Determine whether groups auto-join is enabled.
     1584 *
     1585 * "Auto-join" is the toggle that determines whether users are joined to a
     1586 * public group automatically when creating content in that group.
     1587 *
     1588 * @return bool
     1589 */
    15481590function bp_groups_auto_join() {
    15491591    global $bp;
     
    15521594}
    15531595
     1596/**
     1597 * Output the total member count for a group.
     1598 *
     1599 * @param object $group Optional. Group object. Default: current group in loop.
     1600 */
    15541601function bp_group_total_members( $group = false ) {
    15551602    echo bp_get_group_total_members( $group );
    15561603}
     1604    /**
     1605     * Get the total member count for a group.
     1606     *
     1607     * @param object $group Optional. Group object. Default: current group in loop.
     1608     * @return int
     1609     */
    15571610    function bp_get_group_total_members( $group = false ) {
    15581611        global $groups_template;
     
    15641617    }
    15651618
     1619/**
     1620 * Output the "x members" count string for a group.
     1621 *
     1622 * @param object $group Optional. Group object. Default: current group in loop.
     1623 */
    15661624function bp_group_member_count() {
    15671625    echo bp_get_group_member_count();
    15681626}
     1627    /**
     1628     * Generate the "x members" count string for a group.
     1629     *
     1630     * @param object $group Optional. Group object. Default: current group in loop.
     1631     * @return string
     1632     */
    15691633    function bp_get_group_member_count() {
    15701634        global $groups_template;
Note: See TracChangeset for help on using the changeset viewer.