Changeset 9046
- Timestamp:
- 09/27/2014 12:41:29 AM (11 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-groups/bp-groups-template.php
r9036 r9046 1508 1508 } 1509 1509 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 */ 1510 1519 function bp_group_show_no_groups_message() { 1511 1520 if ( !groups_total_groups_for_user( bp_displayed_user_id() ) ) … … 1515 1524 } 1516 1525 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 */ 1517 1535 function bp_group_is_activity_permalink() { 1518 1536 … … 1523 1541 } 1524 1542 1543 /** 1544 * Output the pagination HTML for a group loop. 1545 */ 1525 1546 function bp_groups_pagination_links() { 1526 1547 echo bp_get_groups_pagination_links(); 1527 1548 } 1549 /** 1550 * Get the pagination HTML for a group loop. 1551 * 1552 * @return string 1553 */ 1528 1554 function bp_get_groups_pagination_links() { 1529 1555 global $groups_template; … … 1532 1558 } 1533 1559 1560 /** 1561 * Output the "Viewing x-y of z groups" pagination message. 1562 */ 1534 1563 function bp_groups_pagination_count() { 1535 1564 echo bp_get_groups_pagination_count(); 1536 1565 } 1566 /** 1567 * Generate the "Viewing x-y of z groups" pagination message. 1568 * 1569 * @return string 1570 */ 1537 1571 function bp_get_groups_pagination_count() { 1538 1572 global $groups_template; … … 1546 1580 } 1547 1581 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 */ 1548 1590 function bp_groups_auto_join() { 1549 1591 global $bp; … … 1552 1594 } 1553 1595 1596 /** 1597 * Output the total member count for a group. 1598 * 1599 * @param object $group Optional. Group object. Default: current group in loop. 1600 */ 1554 1601 function bp_group_total_members( $group = false ) { 1555 1602 echo bp_get_group_total_members( $group ); 1556 1603 } 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 */ 1557 1610 function bp_get_group_total_members( $group = false ) { 1558 1611 global $groups_template; … … 1564 1617 } 1565 1618 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 */ 1566 1624 function bp_group_member_count() { 1567 1625 echo bp_get_group_member_count(); 1568 1626 } 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 */ 1569 1633 function bp_get_group_member_count() { 1570 1634 global $groups_template;
Note: See TracChangeset
for help on using the changeset viewer.