Skip to:
Content

BuddyPress.org

Changeset 10148


Ignore:
Timestamp:
09/27/2015 05:25:02 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Groups Component.

See #6576.

Location:
trunk/src/bp-groups
Files:
19 edited

Legend:

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

    r9982 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Actions.
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    1817 * Protect access to single groups.
    1918 *
    20  * @since BuddyPress (2.1.0)
     19 * @since 2.1.0
    2120 */
    2221function bp_groups_group_access_protection() {
     
    6160     * logged-in users being redirected to wp-login.php.
    6261     *
    63      * @since BuddyPress (2.1.0)
     62     * @since 2.1.0
    6463     *
    6564     * @param bool  $user_has_access True if the user has access to the
     
    195194             * Filters the allowed invite statuses.
    196195             *
    197              * @since BuddyPress (1.5.0)
     196             * @since 1.5.0
    198197             *
    199198             * @param array $value Array of statuses allowed.
     
    226225         * in the creation process.
    227226         *
    228          * @since BuddyPress (1.1.0)
     227         * @since 1.1.0
    229228         */
    230229        do_action( 'groups_create_group_step_save_' . bp_get_groups_current_create_step() );
     
    235234         * Mostly for clearing cache on a generic action name.
    236235         *
    237          * @since BuddyPress (1.1.0)
     236         * @since 1.1.0
    238237         */
    239238        do_action( 'groups_create_group_step_complete' );
     
    271270             * Fires after the group has been successfully created.
    272271             *
    273              * @since BuddyPress (1.1.0)
     272             * @since 1.1.0
    274273             *
    275274             * @param int $new_group_id ID of the newly created group.
     
    349348     * Filters the template to load for the group creation screen.
    350349     *
    351      * @since BuddyPress (1.0.0)
     350     * @since 1.0.0
    352351     *
    353352     * @param string $value Path to the group creation template to load.
     
    394393     * Filters the template to load for the single group screen.
    395394     *
    396      * @since BuddyPress (1.0.0)
     395     * @since 1.0.0
    397396     *
    398397     * @param string $value Path to the single group template to load.
     
    411410 * another function handles this. See {@link bp_legacy_theme_ajax_joinleave_group()}.
    412411 *
    413  * @since BuddyPress (1.2.4)
     412 * @since 1.2.4
    414413 */
    415414function groups_action_leave_group() {
     
    505504 * Load the activity feed for the current group.
    506505 *
    507  * @since BuddyPress (1.2.0)
     506 * @since 1.2.0
    508507 *
    509508 * @return false|null False on failure.
  • trunk/src/bp-groups/bp-groups-activity.php

    r9906 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Activity Functions.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    7978     * Fires at end of registration of the default activity actions for the Groups component.
    8079     *
    81      * @since BuddyPress (1.1.0)
     80     * @since 1.1.0
    8281     */
    8382    do_action( 'groups_register_activity_actions' );
     
    8887 * Format 'created_group' activity actions.
    8988 *
    90  * @since BuddyPress (2.0.0)
     89 * @since 2.0.0
    9190 *
    9291 * @param string $action   Static activity action.
     
    109108     * Filters the 'created_group' activity actions.
    110109     *
    111      * @since BuddyPress (1.2.0)
     110     * @since 1.2.0
    112111     *
    113112     * @param string $action   The 'created_group' activity action.
     
    120119 * Format 'joined_group' activity actions.
    121120 *
    122  * @since BuddyPress (2.0.0)
     121 * @since 2.0.0
    123122 *
    124123 * @param string $action   Static activity action.
     
    152151     * Filters the 'joined_group' activity actions.
    153152     *
    154      * @since BuddyPress (2.0.0)
     153     * @since 2.0.0
    155154     *
    156155     * @param string $action   The 'joined_group' activity actions.
     
    163162 * Format 'group_details_updated' activity actions.
    164163 *
    165  * @since BuddyPress (2.2.0)
     164 * @since 2.2.0
    166165 *
    167166 * @param  string $action   Static activity action.
     
    206205     * Filters the 'group_details_updated' activity actions.
    207206     *
    208      * @since BuddyPress (2.0.0)
     207     * @since 2.0.0
    209208     *
    210209     * @param string $action   The 'group_details_updated' activity actions.
     
    219218 * This reduces database overhead during the activity loop.
    220219 *
    221  * @since BuddyPress (2.0.0)
     220 * @since 2.0.0
    222221 *
    223222 * @param array $activities Array of activity items.
     
    270269 * Set up activity arguments for use with the 'groups' scope.
    271270 *
    272  * @since BuddyPress (2.2.0)
     271 * @since 2.2.0
    273272 *
    274273 * @param array $retval Empty array by default
     
    416415 * Add an activity stream item when a member joins a group.
    417416 *
    418  * @since BuddyPress (1.9.0)
     417 * @since 1.9.0
    419418 *
    420419 * @param int $user_id  ID of the user joining the group.
     
    436435     * Filters the 'membership_accepted' activity actions.
    437436     *
    438      * @since BuddyPress (1.2.0)
     437     * @since 1.2.0
    439438     *
    440439     * @param string $value    The 'membership_accepted' activity action.
     
    457456 * Add an activity item when a group's details are updated.
    458457 *
    459  * @since BuddyPress (2.2.0)
     458 * @since 2.2.0
    460459 *
    461460 * @param  int             $group_id       ID of the group.
     
    530529 * Delete all activity items related to a specific group.
    531530 *
    532  * @since BuddyPress (1.9.0)
     531 * @since 1.9.0
    533532 *
    534533 * @param int $group_id ID of the group.
     
    551550 * joining/leaving the group in quick succession.
    552551 *
    553  * @since BuddyPress (1.9.0)
     552 * @since 1.9.0
    554553 *
    555554 * @param int $group_id ID of the group.
  • trunk/src/bp-groups/bp-groups-admin.php

    r10131 r10148  
    66 * help text, on which this implementation is heavily based.
    77 *
     8 * @since 1.7.0
     9 *
    810 * @package BuddyPress
    9  * @since BuddyPress (1.7.0)
    1011 * @subpackage Groups
    1112 */
    1213
    13 // Exit if accessed directly
     14// Exit if accessed directly.
    1415defined( 'ABSPATH' ) || exit;
    1516
    16 // Include WP's list table class
     17// Include WP's list table class.
    1718if ( !class_exists( 'WP_List_Table' ) ) require( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
    1819
     
    2425 * Register the Groups component admin screen.
    2526 *
    26  * @since BuddyPress (1.7.0)
     27 * @since 1.7.0
    2728 */
    2829function bp_groups_add_admin_menu() {
     
    4950 * main Dashboard menu.
    5051 *
    51  * @since BuddyPress (1.7.0)
     52 * @since 1.7.0
    5253 *
    5354 * @param array $custom_menus Array of BP top-level menu items.
     
    6869 * setting up screen options.
    6970 *
    70  * @since BuddyPress (1.7.0)
     71 * @since 1.7.0
    7172 *
    7273 * @global BP_Groups_List_Table $bp_groups_list_table Groups screen list table.
     
    8687     * Fires at top of groups admin page.
    8788     *
    88      * @since BuddyPress (1.7.0)
     89     * @since 1.7.0
    8990     *
    9091     * @param string $doaction Current $_GET action being performed in admin screen.
     
    137138         * Fires after the registration of all of the default group meta boxes.
    138139         *
    139          * @since BuddyPress (1.7.0)
     140         * @since 1.7.0
    140141         */
    141142        do_action( 'bp_groups_admin_meta_boxes' );
     
    241242         * Filters the allowed status values for the group.
    242243         *
    243          * @since BuddyPress (1.0.2)
     244         * @since 1.0.2
    244245         *
    245246         * @param array $value Array of allowed group statuses.
     
    251252         * Filters the allowed invite status values for the group.
    252253         *
    253          * @since BuddyPress (1.5.0)
     254         * @since 1.5.0
    254255         *
    255256         * @param array $value Array of allowed invite statuses.
     
    375376         * Fires before redirect so plugins can do something first on save action.
    376377         *
    377          * @since BuddyPress (1.6.0)
     378         * @since 1.6.0
    378379         *
    379380         * @param int $group_id ID of the group being edited.
     
    414415         * Filters the URL to redirect to after successfully editing a group.
    415416         *
    416          * @since BuddyPress (1.7.0)
     417         * @since 1.7.0
    417418         *
    418419         * @param string $redirect_to URL to redirect user to.
     
    432433 * Handle save/update of screen options for the Groups component admin screen.
    433434 *
    434  * @since BuddyPress (1.7.0)
     435 * @since 1.7.0
    435436 *
    436437 * @param string $value     Will always be false unless another plugin filters it first.
     
    455456 * Select the appropriate Groups admin screen, and output it.
    456457 *
    457  * @since BuddyPress (1.7.0)
     458 * @since 1.7.0
    458459 */
    459460function bp_groups_admin() {
     
    478479 * Display the single groups edit screen.
    479480 *
    480  * @since BuddyPress (1.7.0)
     481 * @since 1.7.0
    481482 */
    482483function bp_groups_admin_edit() {
     
    560561     * Useful for plugins to modify the group before display.
    561562     *
    562      * @since BuddyPress (1.7.0)
     563     * @since 1.7.0
    563564     *
    564565     * @param BP_Groups_Group $this Instance of the current group being edited. Passed by reference.
     
    636637 * irreversible.
    637638 *
    638  * @since BuddyPress (1.7.0)
     639 * @since 1.7.0
    639640 */
    640641function bp_groups_admin_delete() {
     
    688689 * This screen contains a list of all BuddyPress groups.
    689690 *
    690  * @since BuddyPress (1.7.0)
     691 * @since 1.7.0
    691692 *
    692693 * @global BP_Groups_List_Table $bp_groups_list_table Group screen list table.
     
    715716     * Useful for plugins to modify the messages before display.
    716717     *
    717      * @since BuddyPress (1.7.0)
     718     * @since 1.7.0
    718719     *
    719720     * @param array $messages Array of messages to be displayed.
     
    757758 * Markup for the single group's Settings metabox.
    758759 *
    759  * @since BuddyPress (1.7.0)
     760 * @since 1.7.0
    760761 *
    761762 * @param object $item Information about the current group.
     
    801802 * Output the markup for a single group's Add New Members metabox.
    802803 *
    803  * @since BuddyPress (1.7.0)
     804 * @since 1.7.0
    804805 */
    805806function bp_groups_admin_edit_metabox_add_new_members( $item ) {
     
    815816 * Renders the Members metabox on single group pages.
    816817 *
    817  * @since BuddyPress (1.7.0)
     818 * @since 1.7.0
    818819 *
    819820 * @param BP_Groups_Group $item The BP_Groups_Group object for the current group.
     
    938939                                 * Fires after the listing of a single row for members in a group on the group edit screen.
    939940                                 *
    940                                  * @since BuddyPress (1.8.0)
     941                                 * @since 1.8.0
    941942                                 *
    942943                                 * @param int             $ID   ID of the user being rendered.
     
    971972 * Renders the Status metabox for the Groups admin edit screen.
    972973 *
    973  * @since BuddyPress (1.7.0)
     974 * @since 1.7.0
    974975 *
    975976 * @param object $item Information about the currently displayed group.
     
    10061007 * deprecated soon.
    10071008 *
    1008  * @since BuddyPress (1.8.0)
     1009 * @since 1.8.0
    10091010 *
    10101011 * @param BP_Group_Member_Query $query       A BP_Group_Member_Query object.
     
    10641065 * Get a set of usernames corresponding to a set of user IDs.
    10651066 *
    1066  * @since BuddyPress (1.7.0)
     1067 * @since 1.7.0
    10671068 *
    10681069 * @param array $user_ids Array of user IDs.
     
    10851086 * AJAX handler for group member autocomplete requests.
    10861087 *
    1087  * @since BuddyPress (1.7.0)
     1088 * @since 1.7.0
    10881089 */
    10891090function bp_groups_admin_autocomplete_handler() {
     
    11281129 * List table class for the Groups component admin page.
    11291130 *
    1130  * @since BuddyPress (1.7.0)
     1131 * @since 1.7.0
    11311132 */
    11321133class BP_Groups_List_Table extends WP_List_Table {
     
    11371138     * e.g. "All", "Pending", "Approved", "Spam"...
    11381139     *
    1139      * @since BuddyPress (1.7.0)
     1140     * @since 1.7.0
    11401141     *
    11411142     * @access public
     
    11471148     * Group counts for each group type.
    11481149     *
    1149      * @since BuddyPress (1.7.0)
     1150     * @since 1.7.0
    11501151     *
    11511152     * @access public
     
    11651166     * Constructor
    11661167     *
    1167      * @since BuddyPress (1.7.0)
     1168     * @since 1.7.0
    11681169     */
    11691170    public function __construct() {
     
    11831184     * manipulation required prior to rendering.
    11841185     *
    1185      * @since BuddyPress (1.7.0)
     1186     * @since 1.7.0
    11861187     */
    11871188    public function prepare_items() {
     
    12881289     * Get an array of all the columns on the page.
    12891290     *
    1290      * @since BuddyPress (1.7.0)
     1291     * @since 1.7.0
    12911292     *
    12921293     * @return array Array of column headers.
     
    13061307     * Get name of default primary column
    13071308     *
    1308      * @since BuddyPress (2.3.3)
     1309     * @since 2.3.3
    13091310     * @access protected
    13101311     *
     
    13191320     * Display a message on screen when no items are found ("No groups found").
    13201321     *
    1321      * @since BuddyPress (1.7.0)
     1322     * @since 1.7.0
    13221323     */
    13231324    public function no_items() {
     
    13281329     * Output the Groups data table.
    13291330     *
    1330      * @since BuddyPress (1.7.0)
     1331     * @since 1.7.0
    13311332    */
    13321333    public function display() {
     
    13581359     * Generate content for a single row of the table.
    13591360     *
    1360      * @since BuddyPress (1.7.0)
     1361     * @since 1.7.0
    13611362     *
    13621363     * @param object|array $item The current group item in the loop.
     
    13761377         * Filters the classes applied to a single row in the groups list table.
    13771378         *
    1378          * @since BuddyPress (1.9.0)
     1379         * @since 1.9.0
    13791380         *
    13801381         * @param array  $row_classes Array of classes to apply to the row.
     
    13941395     * Get the list of views available on this table (e.g. "all", "public").
    13951396     *
    1396      * @since BuddyPress (1.7.0)
     1397     * @since 1.7.0
    13971398     */
    13981399    public function get_views() {
     
    14101411             * Fires inside listing of views so plugins can add their own.
    14111412             *
    1412              * @since BuddyPress (1.7.0)
     1413             * @since 1.7.0
    14131414             *
    14141415             * @param string $url_base Current URL base for view.
     
    14231424     * Get bulk actions for single group row.
    14241425     *
    1425      * @since BuddyPress (1.7.0)
     1426     * @since 1.7.0
    14261427     *
    14271428     * @return array Key/value pairs for the bulk actions dropdown.
     
    14321433         * Filters the list of bulk actions to display on a single group row.
    14331434         *
    1434          * @since BuddyPress (1.7.0)
     1435         * @since 1.7.0
    14351436         *
    14361437         * @param array $value Array of bulk actions to display.
     
    14441445     * Get the table column titles.
    14451446     *
    1446      * @since BuddyPress (1.7.0)
     1447     * @since 1.7.0
    14471448     *
    14481449     * @see WP_List_Table::single_row_columns()
     
    14551456         * Filters the titles for the columns for the groups list table.
    14561457         *
    1457          * @since BuddyPress (2.0.0)
     1458         * @since 2.0.0
    14581459         *
    14591460         * @param array $value Array of slugs and titles for the columns.
     
    14811482     * $desc_first = false.
    14821483     *
    1483      * @since BuddyPress (1.7.0)
     1484     * @since 1.7.0
    14841485     *
    14851486     * @return array Array of sortable column names.
     
    15281529     * Markup for the Checkbox column.
    15291530     *
    1530      * @since BuddyPress (1.7.0)
     1531     * @since 1.7.0
    15311532     *
    15321533     * @see WP_List_Table::single_row_columns()
     
    15411542     * Markup for the Group ID column.
    15421543     *
    1543      * @since BuddyPress (1.7.0)
     1544     * @since 1.7.0
    15441545     *
    15451546     * @see WP_List_Table::single_row_columns()
     
    15561557     * Called "comment" in the CSS so we can re-use some WP core CSS.
    15571558     *
    1558      * @since BuddyPress (1.7.0)
     1559     * @since 1.7.0
    15591560     *
    15601561     * @see WP_List_Table::single_row_columns()
     
    15831584         * Filters the group name for a group's column content.
    15841585         *
    1585          * @since BuddyPress (1.7.0)
     1586         * @since 1.7.0
    15861587         *
    15871588         * @param string $value Name of the group being rendered.
     
    16041605         * Filters the actions that will be shown for the column content.
    16051606         *
    1606          * @since BuddyPress (1.7.0)
     1607         * @since 1.7.0
    16071608         *
    16081609         * @param array $value Array of actions to be displayed for the column content.
     
    16351636     * Markup for the Description column.
    16361637     *
    1637      * @since BuddyPress (1.7.0)
     1638     * @since 1.7.0
    16381639     *
    16391640     * @param array $item Information about the current row.
     
    16441645         * Filters the markup for the Description column.
    16451646         *
    1646          * @since BuddyPress (1.0.0)
     1647         * @since 1.0.0
    16471648         *
    16481649         * @param string $value Markup for the Description column.
     
    16551656     * Markup for the Status column.
    16561657     *
    1657      * @since BuddyPress (1.7.0)
     1658     * @since 1.7.0
    16581659     *
    16591660     * @param array $item Information about the current row.
     
    16801681         * Filters the markup for the Status column.
    16811682         *
    1682          * @since BuddyPress (1.7.0)
     1683         * @since 1.7.0
    16831684         *
    16841685         * @param string $status_desc Markup for the Status column.
     
    16911692     * Markup for the Number of Members column.
    16921693     *
    1693      * @since BuddyPress (1.7.0)
     1694     * @since 1.7.0
    16941695     *
    16951696     * @param array $item Information about the current row.
     
    17011702         * Filters the markup for the number of Members column.
    17021703         *
    1703          * @since BuddyPress (1.7.0)
     1704         * @since 1.7.0
    17041705         *
    17051706         * @param int   $count Markup for the number of Members column.
     
    17121713     * Markup for the Last Active column.
    17131714     *
    1714      * @since BuddyPress (1.7.0)
     1715     * @since 1.7.0
    17151716     *
    17161717     * @param array $item Information about the current row.
     
    17221723         * Filters the markup for the Last Active column.
    17231724         *
    1724          * @since BuddyPress (1.7.0)
     1725         * @since 1.7.0
    17251726         *
    17261727         * @param string $last_active Markup for the Last Active column.
     
    17331734     * Allow plugins to add their custom column.
    17341735     *
    1735      * @since BuddyPress (2.0.0)
     1736     * @since 2.0.0
    17361737     *
    17371738     * @param array  $item        Information about the current row.
     
    17451746         * Filters a string to allow plugins to add custom column content.
    17461747         *
    1747          * @since BuddyPress (2.0.0)
     1748         * @since 2.0.0
    17481749         *
    17491750         * @param string $value       Empty string.
  • trunk/src/bp-groups/bp-groups-adminbar.php

    r9906 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Toolbar.
     
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
     
    1615 * Add the Group Admin top-level menu when viewing group pages.
    1716 *
    18  * @since BuddyPress (1.5.0)
     17 * @since 1.5.0
    1918 *
    2019 * @todo Add dynamic menu items for group extensions.
     
    8685 * Remove rogue WP core Edit menu when viewing a single group.
    8786 *
    88  * @since BuddyPress (1.6.0)
     87 * @since 1.6.0
    8988 */
    9089function bp_groups_remove_edit_page_menu() {
  • trunk/src/bp-groups/bp-groups-cache.php

    r9906 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Caching.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    6261 * Bust group caches when editing or deleting.
    6362 *
    64  * @since BuddyPress (1.7.0)
     63 * @since 1.7.0
    6564 *
    6665 * @param int $group_id The group being edited.
     
    7776 * Bust group cache when modifying metadata.
    7877 *
    79  * @since BuddyPress (2.0.0)
     78 * @since 2.0.0
    8079 *
    8180 * @param int $meta_id
     
    9190 * Clear caches for the group creator when a group is created.
    9291 *
    93  * @since BuddyPress (1.6.0)
     92 * @since 1.6.0
    9493 *
    9594 * @param int             $group_id  ID of the group.
     
    105104 * Clears caches for all members in a group when a group is deleted.
    106105 *
    107  * @since BuddyPress (1.6.0)
     106 * @since 1.6.0
    108107 *
    109108 * @param BP_Groups_Group $group_obj Group object.
     
    122121 * Count is cleared when an invite is accepted, rejected or deleted.
    123122 *
    124  * @since BuddyPress (2.0.0)
     123 * @since 2.0.0
    125124 *
    126125 * @param int $user_id The user ID.
     
    138137 * Groan. Our API functions are not consistent.
    139138 *
    140  * @since BuddyPress (2.0.0)
     139 * @since 2.0.0
    141140 *
    142141 * @param int $group_id The group ID. Not used in this function.
     
    151150 * Clear a user's cached total group invite count when a new invite is sent.
    152151 *
    153  * @since BuddyPress (2.0.0)
     152 * @since 2.0.0
    154153 *
    155154 * @param int   $group_id      The group ID. Not used in this function.
     
    182181 * Clear group administrator cache.
    183182 *
    184  * @since BuddyPress (2.1.0)
     183 * @since 2.1.0
    185184 *
    186185 * @param int $group_id The group ID.
     
    199198 * using {@link BP_Groups_Member::save()}.  Usually via a plugin.
    200199 *
    201  * @since BuddyPress (2.1.0)
     200 * @since 2.1.0
    202201 *
    203202 * @param BP_Groups_Member $member
  • trunk/src/bp-groups/bp-groups-classes.php

    r9819 r10148  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
  • trunk/src/bp-groups/bp-groups-filters.php

    r9975 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Filters.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    7069 * Filter output of Group Description through WordPress's KSES API.
    7170 *
    72  * @since BuddyPress (1.1.0)
     71 * @since 1.1.0
    7372 *
    7473 * @param string $content
     
    102101     * Filters the HTML elements allowed for a given context.
    103102     *
    104      * @since BuddyPress (1.2.0)
     103     * @since 1.2.0
    105104     *
    106105     * @param string $allowed_tags Allowed tags, attributes, and/or entities.
     
    236235 * This speeds up the query.
    237236 *
    238  * @since BuddyPress (1.5.0)
     237 * @since 1.5.0
    239238 *
    240239 * @see BB_Query::_filter_sql()
     
    247246     * This filter is used to prevent fetching information that is not used.
    248247     *
    249      * @since BuddyPress (1.5.0)
     248     * @since 1.5.0
    250249     *
    251250     * @param string $value SQL string to specify fetching just topic_id.
     
    259258 * mentions suggestions?
    260259 *
    261  * @since BuddyPress (2.2.0)
     260 * @since 2.2.0
    262261 *
    263262 * @param bool $load_mentions    True to load mentions assets, false otherwise.
  • trunk/src/bp-groups/bp-groups-forums.php

    r9906 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Forums.
     
    1514 */
    1615
    17 // Exit if accessed directly
     16// Exit if accessed directly.
    1817defined( 'ABSPATH' ) || exit;
    1918
     
    2322 * Uses the bundled version of bbPress packaged with BuddyPress.
    2423 *
    25  * @since BuddyPress (1.0.0)
     24 * @since 1.0.0
    2625 *
    2726 * @param int    $group_id   The group ID that the new forum should be attached to.
     
    5352     * Fires after the creation of a new forum inside a specific BuddyPress group.
    5453     *
    55      * @since BuddyPress (1.0.0)
     54     * @since 1.0.0
    5655     *
    5756     * @param int $forum_id ID of the newly created forum.
     
    6463 * Update group forum metadata (title, description, slug) when the group's details are edited.
    6564 *
    66  * @since BuddyPress (1.1.0)
     65 * @since 1.1.0
    6766 *
    6867 * @param int $group_id Group id, passed from groups_details_updated.
     
    8887     * Filters the group forum metadata value argument.
    8988     *
    90      * @since BuddyPress (1.2.5)
     89     * @since 1.2.5
    9190     *
    9291     * @param array $value Array of metadata values to update the group forum with.
     
    106105 * Uses the bundled version of bbPress packaged with BuddyPress.
    107106 *
    108  * @since BuddyPress (1.0.0)
     107 * @since 1.0.0
    109108 *
    110109 * @param string $post_text The text for the forum post.
     
    124123     * Filters the text for the forum post before save.
    125124     *
    126      * @since BuddyPress (1.2.0)
     125     * @since 1.2.0
    127126     *
    128127     * @param string $post_text Text for the forum post.
     
    133132     * Filters the ID for the forum post before save.
    134133     *
    135      * @since BuddyPress (1.2.0)
     134     * @since 1.2.0
    136135     *
    137136     * @param int $topic_id ID of the topic the post will be associated with.
     
    159158     * Filters the new groups activity forum post action.
    160159     *
    161      * @since BuddyPress (1.2.0)
     160     * @since 1.2.0
    162161     *
    163162     * @param string $activity_action Formatted action related to group activity posting.
     
    171170     * Filters the new groups activity forum post content.
    172171     *
    173      * @since BuddyPress (1.2.0)
     172     * @since 1.2.0
    174173     *
    175174     * @param string $activity_content Excerpt-length activity content to be posted.
     
    183182     * Filters the new groups activity forum post primary link.
    184183     *
    185      * @since BuddyPress (1.1.0)
     184     * @since 1.1.0
    186185     *
    187186     * @param string $value URL to the newly posted forum post.
     
    201200     * Fires after the creation of a new group forum topic post.
    202201     *
    203      * @since BuddyPress (1.0.0)
     202     * @since 1.0.0
    204203     *
    205204     * @param int $value   ID of the current group.
     
    216215 * Uses the bundled version of bbPress packaged with BuddyPress.
    217216 *
    218  * @since BuddyPress (1.0.0)
     217 * @since 1.0.0
    219218 *
    220219 * @param string $topic_title The title for the forum topic.
     
    232231     * Filters the new groups forum topic title before saving.
    233232     *
    234      * @since BuddyPress (1.2.0)
     233     * @since 1.2.0
    235234     *
    236235     * @param string $topic_title The title for the forum topic.
     
    241240     * Filters the new groups forum topic text before saving.
    242241     *
    243      * @since BuddyPress (1.2.0)
     242     * @since 1.2.0
    244243     *
    245244     * @param string $topic_text The text for the forum topic.
     
    250249     * Filters the new groups forum topic tags before saving.
    251250     *
    252      * @since BuddyPress (1.2.0)
     251     * @since 1.2.0
    253252     *
    254253     * @param string $topic_tags A comma-delimited string of topic tags.
     
    259258     * Filters the forum ID this forum topic resides in.
    260259     *
    261      * @since BuddyPress (1.2.0)
     260     * @since 1.2.0
    262261     *
    263262     * @param string $forum_id The forum ID this forum topic resides in.
     
    282281     * Filters the new groups activity forum topic action.
    283282     *
    284      * @since BuddyPress (1.2.0)
     283     * @since 1.2.0
    285284     *
    286285     * @param string $activity_action Formatted action related to forum topic.
     
    293292     * Filters the new groups activity forum topic content.
    294293     *
    295      * @since BuddyPress (1.2.0)
     294     * @since 1.2.0
    296295     *
    297296     * @param string $activity_content Excerpt-length activity content to be posted.
     
    304303     * Filters the new groups activity forum topic primary link.
    305304     *
    306      * @since BuddyPress (1.1.0)
     305     * @since 1.1.0
    307306     *
    308307     * @param string $value Concatenated primary link.
     
    322321     * Fires after the creation of a new group forum topic.
    323322     *
    324      * @since BuddyPress (1.0.0)
     323     * @since 1.0.0
    325324     *
    326325     * @param int    $value ID of the current group.
     
    337336 * Uses the bundled version of bbPress packaged with BuddyPress.
    338337 *
    339  * @since BuddyPress (1.1.0)
     338 * @since 1.1.0
    340339 *
    341340 * @param int    $topic_id    The topic ID of the existing forum topic.
     
    402401     * Fires after the update of a group forum topic.
    403402     *
    404      * @since BuddyPress (1.1.0)
     403     * @since 1.1.0
    405404     *
    406405     * @param object $topic Object holding current topic being updated. Passed by reference.
     
    416415 * Uses the bundled version of bbPress packaged with BuddyPress.
    417416 *
    418  * @since BuddyPress (1.1.0)
     417 * @since 1.1.0
    419418 *
    420419 * @param int    $post_id   The post ID of the existing forum post.
     
    490489     * Fires after the update of a group forum post.
    491490     *
    492      * @since BuddyPress (1.1.0)
     491     * @since 1.1.0
    493492     *
    494493     * @param object $post  Object holding current post being updated.
     
    505504 * Uses the bundled version of bbPress packaged with BuddyPress.
    506505 *
    507  * @since BuddyPress (1.1.0)
     506 * @since 1.1.0
    508507 *
    509508 * @param int $topic_id The ID of the topic to be deleted.
     
    523522         * Fires before the deletion of a group forum topic.
    524523         *
    525          * @since BuddyPress (1.2.9)
     524         * @since 1.2.9
    526525         *
    527526         * @param int $topic_id ID of the topic to be deleted.
     
    554553         * Fires after the deletion of a group forum topic.
    555554         *
    556          * @since BuddyPress (1.1.0)
     555         * @since 1.1.0
    557556         *
    558557         * @param int $topic_id ID of the topic that was deleted.
     
    569568 * Uses the bundled version of bbPress packaged with BuddyPress.
    570569 *
    571  * @since BuddyPress (1.1.0)
     570 * @since 1.1.0
    572571 *
    573572 * @param int      $post_id  The ID of the post you want to delete.
     
    587586         * Fires before the deletion of a group forum post.
    588587         *
    589          * @since BuddyPress (1.5.0)
     588         * @since 1.5.0
    590589         *
    591590         * @param int $post_id  ID of the post to be deleted.
     
    607606         * Fires after the deletion of a group forum post.
    608607         *
    609          * @since BuddyPress (1.1.0)
     608         * @since 1.1.0
    610609         *
    611610         * @param int $post_id  ID of the post that was deleted.
     
    621620 * Get a total count of all public topics of a given type, across groups/forums.
    622621 *
    623  * @since BuddyPress (1.5.0)
     622 * @since 1.5.0
    624623 *
    625624 * @param string $type Either 'newest', 'popular', 'unreplied', 'tags'.
     
    633632     * Filters the total count of all public topics of a given type, across groups/forums.
    634633     *
    635      * @since BuddyPress (1.1.0)
     634     * @since 1.1.0
    636635     *
    637636     * @param int $value Total count of all public topics.
     
    643642 * Get a total count of all topics of a given status, across groups/forums.
    644643 *
    645  * @since BuddyPress (1.5.0)
     644 * @since 1.5.0
    646645 *
    647646 * @param string      $status       Which groups to count. 'public', 'private', 'hidden',
     
    656655     * Filters the total count of all topics of a given status, across groups/forums.
    657656     *
    658      * @since BuddyPress (1.5.0)
     657     * @since 1.5.0
    659658     *
    660659     * @param int $value Total count of all topics.
  • trunk/src/bp-groups/bp-groups-functions.php

    r9907 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Functions.
     
    1312 */
    1413
    15 // Exit if accessed directly
     14// Exit if accessed directly.
    1615defined( 'ABSPATH' ) || exit;
    1716
     
    1918 * Check whether there is a Groups directory page in the $bp global.
    2019 *
    21  * @since BuddyPress (1.5.0)
     20 * @since 1.5.0
    2221 *
    2322 * @return bool True if set, False if empty.
     
    6261     * Filters a single group object.
    6362     *
    64      * @since BuddyPress (1.2.0)
     63     * @since 1.2.0
    6564     *
    6665     * @param BP_Groups_Group $group Single group object.
     
    7473 * Create a group.
    7574 *
    76  * @since BuddyPress (1.0.0)
     75 * @since 1.0.0
    7776 *
    7877 * @param array|string $args {
     
    172171         * Fires after the creation of a new group and a group creator needs to be made.
    173172         *
    174          * @since BuddyPress (1.5.0)
     173         * @since 1.5.0
    175174         *
    176175         * @param int              $id     ID of the newly created group.
     
    186185         * Fires after the update of a group.
    187186         *
    188          * @since BuddyPress (1.5.0)
     187         * @since 1.5.0
    189188         *
    190189         * @param int             $id    ID of the updated group.
     
    197196     * Fires after the creation or update of a group.
    198197     *
    199      * @since BuddyPress (1.0.0)
     198     * @since 1.0.0
    200199     *
    201200     * @param int             $id    ID of the newly created group.
     
    242241     * Fired after a group's details are updated.
    243242     *
    244      * @since BuddyPress (2.2.0)
     243     * @since 2.2.0
    245244     *
    246245     * @param int             $value          ID of the group.
     
    301300     * Fires after the update of a groups settings.
    302301     *
    303      * @since BuddyPress (1.0.0)
     302     * @since 1.0.0
    304303     *
    305304     * @param int $id ID of the group that was updated.
     
    313312 * Delete a group and all of its associated metadata.
    314313 *
    315  * @since BuddyPress (1.0.0)
     314 * @since 1.0.0
    316315 *
    317316 * @param int $group_id ID of the group to delete.
     
    324323     * Fires before the deletion of a group.
    325324     *
    326      * @since BuddyPress (1.5.0)
     325     * @since 1.5.0
    327326     *
    328327     * @param int $group_id ID of the group to be deleted.
     
    344343     * Fires after the deletion of a group.
    345344     *
    346      * @since BuddyPress (1.0.0)
     345     * @since 1.0.0
    347346     *
    348347     * @param int $group_id ID of the group that was deleted.
     
    407406 * Get a group ID by its slug.
    408407 *
    409  * @since BuddyPress (1.6.0)
     408 * @since 1.6.0
    410409 *
    411410 * @param string $group_slug The group's slug.
     
    450449     * Fires after a user leaves a group.
    451450     *
    452      * @since BuddyPress (1.0.0)
     451     * @since 1.0.0
    453452     *
    454453     * @param int $group_id ID of the group.
     
    515514     * Fires after a user joins a group.
    516515     *
    517      * @since BuddyPress (1.0.0)
     516     * @since 1.0.0
    518517     *
    519518     * @param int $group_id ID of the group.
     
    719718     * Filters the collection of groups based on parsed parameters.
    720719     *
    721      * @since BuddyPress (1.2.0)
     720     * @since 1.2.0
    722721     *
    723722     * @param BP_Groups_Group $groups Object of found groups based on parameters.
     
    791790 * Get the BP_Groups_Group object corresponding to the current group.
    792791 *
    793  * @since BuddyPress (1.5.0)
     792 * @since 1.5.0
    794793 *
    795794 * @return BP_Groups_Group The current group object.
     
    805804     * Filters the BP_Groups_Group object corresponding to the current group.
    806805     *
    807      * @since BuddyPress (1.5.0)
     806     * @since 1.5.0
    808807     *
    809808     * @param BP_Groups_Group $current_group Current BP_Groups_Group object.
     
    837836     * Filters the avatar upload directory path for a given group.
    838837     *
    839      * @since BuddyPress (1.1.0)
     838     * @since 1.1.0
    840839     *
    841840     * @param array $value Array of parts related to the groups avatar upload directory.
     
    896895 * Is the specified user the creator of the group?
    897896 *
    898  * @since BuddyPress (1.2.6)
     897 * @since 1.2.6
    899898 *
    900899 * @param int $user_id ID of the user.
     
    955954     * Filters the action for the new group activity update.
    956955     *
    957      * @since BuddyPress (1.2.0)
     956     * @since 1.2.0
    958957     *
    959958     * @param string $activity_action The new group activity update.
     
    964963     * Filters the content for the new group activity update.
    965964     *
    966      * @since BuddyPress (1.2.0)
     965     * @since 1.2.0
    967966     *
    968967     * @param string $activity_content The content of the update.
     
    983982     * Fires after posting of an Activity status update affiliated with a group.
    984983     *
    985      * @since BuddyPress (1.2.0)
     984     * @since 1.2.0
    986985     *
    987986     * @param string $content     The content of the update.
     
    10191018 * Get the total group invite count for a user.
    10201019 *
    1021  * @since BuddyPress (2.0.0)
     1020 * @since 2.0.0
    10221021 *
    10231022 * @param int $user_id The user ID.
     
    10841083         * Fires after the creation of a new group invite.
    10851084         *
    1086          * @since BuddyPress (1.0.0)
     1085         * @since 1.0.0
    10871086         *
    10881087         * @param array $args Array of parsed arguments for the group invite.
     
    11121111     * Fires after uninviting a user from a group.
    11131112     *
    1114      * @since BuddyPress (1.0.0)
     1113     * @since 1.0.0
    11151114     *
    11161115     * @param int $group_id ID of the group being uninvited from.
     
    11661165     * Fires after a user has accepted a group invite.
    11671166     *
    1168      * @since BuddyPress (1.0.0)
     1167     * @since 1.0.0
    11691168     *
    11701169     * @param int $user_id  ID of the user who accepted the group invite.
     
    11911190     * Fires after a user rejects a group invitation.
    11921191     *
    1193      * @since BuddyPress (1.0.0)
     1192     * @since 1.0.0
    11941193     *
    11951194     * @param int $user_id  ID of the user rejecting the invite.
     
    12161215     * Fires after the deletion of a group invitation.
    12171216     *
    1218      * @since BuddyPress (1.9.0)
     1217     * @since 1.9.0
    12191218     *
    12201219     * @param int $user_id  ID of the user whose invitation is being deleted.
     
    12541253     * Fires after the sending of invites for a group.
    12551254     *
    1256      * @since BuddyPress (1.0.0)
     1255     * @since 1.0.0
    12571256     *
    12581257     * @param int   $group_id      ID of the group who's being invited to.
     
    13281327     * Fires before the promotion of a user to a new status.
    13291328     *
    1330      * @since BuddyPress (1.6.0)
     1329     * @since 1.6.0
    13311330     *
    13321331     * @param int    $group_id ID of the group being promoted in.
     
    13571356     * Fires before the demotion of a user to 'member'.
    13581357     *
    1359      * @since BuddyPress (1.0.0)
     1358     * @since 1.0.0
    13601359     *
    13611360     * @param int $group_id ID of the group being demoted in.
     
    13851384     * Fires before the banning of a member from a group.
    13861385     *
    1387      * @since BuddyPress (1.0.0)
     1386     * @since 1.0.0
    13881387     *
    13891388     * @param int $group_id ID of the group being banned from.
     
    14131412     * Fires before the unbanning of a member from a group.
    14141413     *
    1415      * @since BuddyPress (1.0.0)
     1414     * @since 1.0.0
    14161415     *
    14171416     * @param int $group_id ID of the group being unbanned from.
     
    14511450     * Fires before the removal of a member from a group.
    14521451     *
    1453      * @since BuddyPress (1.2.6)
     1452     * @since 1.2.6
    14541453     *
    14551454     * @param int $group_id ID of the group being removed from.
     
    15071506         * Fires after the creation of a new membership request.
    15081507         *
    1509          * @since BuddyPress (1.0.0)
     1508         * @since 1.0.0
    15101509         *
    15111510         * @param int   $requesting_user_id  ID of the user requesting membership.
     
    15571556     * Fires after a group membership request has been accepted.
    15581557     *
    1559      * @since BuddyPress (1.0.0)
     1558     * @since 1.0.0
    15601559     *
    15611560     * @param int  $user_id  ID of the user who accepted membership.
     
    15891588     * Fires after a group membership request has been rejected.
    15901589     *
    1591      * @since BuddyPress (1.0.0)
     1590     * @since 1.0.0
    15921591     *
    15931592     * @param int  $user_id  ID of the user who rejected membership.
     
    16561655     * Fires after the acceptance of all pending membership requests to a group.
    16571656     *
    1658      * @since BuddyPress (1.0.2)
     1657     * @since 1.0.2
    16591658     *
    16601659     * @param int $group_id ID of the group whose pending memberships were accepted.
     
    17501749 * Add a piece of group metadata.
    17511750 *
    1752  * @since BuddyPress (2.0.0)
     1751 * @since 2.0.0
    17531752 *
    17541753 * @param int    $group_id   ID of the group.
    17551754 * @param string $meta_key   Metadata key.
    17561755 * @param mixed  $meta_value Metadata value.
    1757  * @param bool   $unique.    Optional. Whether to enforce a single metadata value
     1756 * @param bool   $unique     Optional. Whether to enforce a single metadata value
    17581757 *                           for the given key. If true, and the object already
    17591758 *                           has a value for the key, no change will be made.
     
    17751774 * Delete all group membership information for the specified user.
    17761775 *
    1777  * @since BuddyPress (1.0.0)
     1776 * @since 1.0.0
    17781777 *
    17791778 * @param int $user_id ID of the user.
     
    17851784     * Fires after the deletion of all data for a user.
    17861785     *
    1787      * @since BuddyPress (1.1.0)
     1786     * @since 1.1.0
    17881787     *
    17891788     * @param int $user_id ID of the user whose data is being deleted.
  • trunk/src/bp-groups/bp-groups-loader.php

    r10110 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Loader.
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    2019     * Auto-join group when non group member performs group activity.
    2120     *
    22      * @since BuddyPress (1.5.0)
     21     * @since 1.5.0
    2322     * @access public
    2423     * @var bool
     
    2928     * The group being currently accessed.
    3029     *
    31      * @since BuddyPress (1.5.0)
     30     * @since 1.5.0
    3231     * @access public
    3332     * @var BP_Groups_Group
     
    3837     * Default group extension.
    3938     *
    40      * @since BuddyPress (1.6.0)
     39     * @since 1.6.0
    4140     * @access public
    4241     * @todo Is this used anywhere? Is this a duplicate of $default_extension?
     
    4746     * Default group extension.
    4847     *
    49      * @since BuddyPress (1.6.0)
     48     * @since 1.6.0
    5049     * @access public
    5150     * @var string
     
    5655     * Illegal group names/slugs.
    5756     *
    58      * @since BuddyPress (1.5.0)
     57     * @since 1.5.0
    5958     * @access public
    6059     * @var array
     
    6564     * Group creation/edit steps (e.g. Details, Settings, Avatar, Invites).
    6665     *
    67      * @since BuddyPress (1.5.0)
     66     * @since 1.5.0
    6867     * @access public
    6968     * @var array
     
    7473     * Types of group statuses (Public, Private, Hidden).
    7574     *
    76      * @since BuddyPress (1.5.0)
     75     * @since 1.5.0
    7776     * @access public
    7877     * @var array
     
    8382     * Start the groups component creation process.
    8483     *
    85      * @since BuddyPress (1.5.0)
     84     * @since 1.5.0
    8685     */
    8786    public function __construct() {
     
    10099     * Include Groups component files.
    101100     *
    102      * @since BuddyPress (1.5.0)
     101     * @since 1.5.0
    103102     *
    104103     * @see BP_Component::includes() for a description of arguments.
     
    135134     * backwards compatibility.
    136135     *
    137      * @since BuddyPress (1.5.0)
     136     * @since 1.5.0
    138137     *
    139138     * @see BP_Component::setup_globals() for a description of arguments.
     
    186185             * Filters the current PHP Class being used.
    187186             *
    188              * @since BuddyPress (1.5.0)
     187             * @since 1.5.0
    189188             *
    190189             * @param string $value Name of the class being used.
     
    203202                 * Filters the current group object being instantiated from previous filter.
    204203                 *
    205                  * @since BuddyPress (1.5.0)
     204                 * @since 1.5.0
    206205                 *
    207206                 * @param object $value Newly instantiated object for the group.
     
    261260         * Filters the list of illegal groups names/slugs.
    262261         *
    263          * @since BuddyPress (1.0.0)
     262         * @since 1.0.0
    264263         *
    265264         * @param array $value Array of illegal group names/slugs.
     
    291290         * Filters the preconfigured groups creation steps.
    292291         *
    293          * @since BuddyPress (1.1.0)
     292         * @since 1.1.0
    294293         *
    295294         * @param array $value Array of preconfigured group creation steps.
     
    326325         * Filters the list of valid groups statuses.
    327326         *
    328          * @since BuddyPress (1.1.0)
     327         * @since 1.1.0
    329328         *
    330329         * @param array $value Array of valid group statuses.
     
    343342     * Set up canonical stack for this component.
    344343     *
    345      * @since BuddyPress (2.1.0)
     344     * @since 2.1.0
    346345     */
    347346    public function setup_canonical_stack() {
     
    357356         * Filters the default groups extension.
    358357         *
    359          * @since BuddyPress (1.6.0)
     358         * @since 1.6.0
    360359         *
    361360         * @param string $value BP_GROUPS_DEFAULT_EXTENSION constant if defined,
     
    392391     * Set up component navigation.
    393392     *
    394      * @since BuddyPress (1.5.0)
     393     * @since 1.5.0
    395394     *
    396395     * @see BP_Component::setup_nav() for a description of arguments.
     
    622621             * Fires at the end of the groups navigation setup if user has access.
    623622             *
    624              * @since BuddyPress (1.0.2)
     623             * @since 1.0.2
    625624             *
    626625             * @param bool $user_has_access Whether or not user has access.
     
    741740     * Setup cache groups
    742741     *
    743      * @since BuddyPress (2.2.0)
     742     * @since 2.2.0
    744743     */
    745744    public function setup_cache_groups() {
     
    760759 * Bootstrap the Notifications component.
    761760 *
    762  * @since BuddyPress (1.5.0)
     761 * @since 1.5.0
    763762 */
    764763function bp_setup_groups() {
  • trunk/src/bp-groups/bp-groups-notifications.php

    r9970 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Notification Functions.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    1918 * Notify all group members when a group is updated.
    2019 *
    21  * @since BuddyPress (1.0.0)
     20 * @since 1.0.0
    2221 *
    2322 * @param int                  $group_id  ID of the group.
     
    5150     * Filters the bullet points listing updated items in the email notification after a group is updated.
    5251     *
    53      * @since BuddyPress (2.2.0)
     52     * @since 2.2.0
    5453     *
    5554     * @param array $changed Array of bullet points.
     
    9493         * Filters the user email that the group update notification will be sent to.
    9594         *
    96          * @since BuddyPress (1.2.0)
     95         * @since 1.2.0
    9796         *
    9897         * @param string $to User email the notification is being sent to.
     
    103102         * Filters the group update notification subject that will be sent to user.
    104103         *
    105          * @since BuddyPress (1.2.0)
     104         * @since 1.2.0
    106105         *
    107106         * @param string          $subject Email notification subject text.
     
    113112         * Filters the group update notification message that will be sent to user.
    114113         *
    115          * @since BuddyPress (1.2.0)
     114         * @since 1.2.0
    116115         *
    117116         * @param string          $message       Email notification message text.
     
    132131     * See https://buddypress.trac.wordpress.org/ticket/3644 for blank message parameter.
    133132     *
    134      * @since BuddyPress (1.5.0)
     133     * @since 1.5.0
    135134     *
    136135     * @param array  $user_ids Array of user IDs to notify about the update.
     
    145144 * Notify group admin about new membership request.
    146145 *
    147  * @since BuddyPress (1.0.0)
     146 * @since 1.0.0
    148147 *
    149148 * @param int $requesting_user_id ID of the user requesting group membership.
     
    234233     * Filters the user email that the group membership request will be sent to.
    235234     *
    236      * @since BuddyPress (1.2.0)
     235     * @since 1.2.0
    237236     *
    238237     * @param string $to User email the request is being sent to.
     
    243242     * Filters the group membership request subject that will be sent to user.
    244243     *
    245      * @since BuddyPress (1.2.0)
     244     * @since 1.2.0
    246245     *
    247246     * @param string          $subject Membership request email subject text.
     
    253252     * Filters the group membership request message that will be sent to user.
    254253     *
    255      * @since BuddyPress (1.2.0)
     254     * @since 1.2.0
    256255     *
    257256     * @param string          $message              Membership request email message text.
     
    269268     * Fires after the notification is sent that a member has requested group membership.
    270269     *
    271      * @since BuddyPress (1.5.0)
     270     * @since 1.5.0
    272271     *
    273272     * @param int    $admin_id           ID of the group administrator.
     
    284283 * Notify member about their group membership request.
    285284 *
    286  * @since BuddyPress (1.0.0)
     285 * @since 1.0.0
    287286 *
    288287 * @param int  $requesting_user_id ID of the user requesting group membership.
     
    353352     * Filters the user email that the group membership request result will be sent to.
    354353     *
    355      * @since BuddyPress (1.2.0)
     354     * @since 1.2.0
    356355     *
    357356     * @param string $to User email the request result is being sent to.
     
    362361     * Filters the group membership request result subject that will be sent to user.
    363362     *
    364      * @since BuddyPress (1.2.0)
     363     * @since 1.2.0
    365364     *
    366365     * @param string          $subject Membership request result email subject text.
     
    372371     * Filters the group membership request result message that will be sent to user.
    373372     *
    374      * @since BuddyPress (1.2.0)
     373     * @since 1.2.0
    375374     *
    376375     * @param string          $message       Membership request result email message text.
     
    386385     * Fires after the notification is sent that a membership has been approved.
    387386     *
    388      * @since BuddyPress (1.5.0)
     387     * @since 1.5.0
    389388     *
    390389     * @param int    $requesting_user_id ID of the user whose membership was approved.
     
    401400 * Notify group member they have been promoted.
    402401 *
    403  * @since BuddyPress (1.0.0)
     402 * @since 1.0.0
    404403 *
    405404 * @param int $user_id  ID of the user.
     
    459458     * Filters the user email that the group promotion notification will be sent to.
    460459     *
    461      * @since BuddyPress (1.2.0)
     460     * @since 1.2.0
    462461     *
    463462     * @param string $to User email the promotion notification is being sent to.
     
    468467     * Filters the group promotion notification subject that will be sent to user.
    469468     *
    470      * @since BuddyPress (1.2.0)
     469     * @since 1.2.0
    471470     *
    472471     * @param string          $subject Promotion notification email subject text.
     
    478477     * Filters the group promotion notification message that will be sent to user.
    479478     *
    480      * @since BuddyPress (1.2.0)
     479     * @since 1.2.0
    481480     *
    482481     * @param string          $message       Promotion notification email message text.
     
    493492     * Fires after the notification is sent that a member has been promoted.
    494493     *
    495      * @since BuddyPress (1.5.0)
     494     * @since 1.5.0
    496495     *
    497496     * @param int    $user_id  ID of the user who was promoted.
     
    507506 * Notify a member they have been invited to a group.
    508507 *
    509  * @since BuddyPress (1.0.0)
     508 * @since 1.0.0
    510509 *
    511510 * @param BP_Groups_Group  $group           Group object.
     
    575574     * Filters the user email that the group invite notification will be sent to.
    576575     *
    577      * @since BuddyPress (1.2.0)
     576     * @since 1.2.0
    578577     *
    579578     * @param string $to User email the invite notification is being sent to.
     
    584583     * Filters the group invite notification subject that will be sent to user.
    585584     *
    586      * @since BuddyPress (1.2.0)
     585     * @since 1.2.0
    587586     *
    588587     * @param string          $subject Invite notification email subject text.
     
    594593     * Filters the group invite notification message that will be sent to user.
    595594     *
    596      * @since BuddyPress (1.2.0)
     595     * @since 1.2.0
    597596     *
    598597     * @param string          $message       Invite notification email message text.
     
    611610     * Fires after the notification is sent that a member has been invited to a group.
    612611     *
    613      * @since BuddyPress (1.5.0)
     612     * @since 1.5.0
    614613     *
    615614     * @param int             $invited_user_id  ID of the user who was invited.
     
    626625 * Format notifications for the Groups component.
    627626 *
    628  * @since BuddyPress (1.0.0)
     627 * @since 1.0.0
    629628 *
    630629 * @param string $action            The kind of notification being rendered.
     
    665664                     * Complete filter - bp_groups_multiple_new_membership_requests_notification.
    666665                     *
    667                      * @since BuddyPress (1.0.0)
     666                     * @since 1.0.0
    668667                     *
    669668                     * @param string $string            HTML anchor tag for request.
     
    683682                     * Complete filter - bp_groups_multiple_new_membership_requests_notification.
    684683                     *
    685                      * @since BuddyPress (1.0.0)
     684                     * @since 1.0.0
    686685                     *
    687686                     * @param array  $array             Array holding permalink and content for notification.
     
    710709                     * Complete filter - bp_groups_single_new_membership_request_notification.
    711710                     *
    712                      * @since BuddyPress (1.0.0)
     711                     * @since 1.0.0
    713712                     *
    714713                     * @param string $string            HTML anchor tag for request.
     
    728727                     * Complete filter - bp_groups_single_new_membership_request_notification.
    729728                     *
    730                      * @since BuddyPress (1.0.0)
     729                     * @since 1.0.0
    731730                     *
    732731                     * @param array  $array             Array holding permalink and content for notification.
     
    764763                     * Complete filter - bp_groups_multiple_membership_request_accepted_notification.
    765764                     *
    766                      * @since BuddyPress (1.0.0)
     765                     * @since 1.0.0
    767766                     *
    768767                     * @param string $string            HTML anchor tag for notification.
     
    779778                     * Complete filter - bp_groups_multiple_membership_request_accepted_notification.
    780779                     *
    781                      * @since BuddyPress (1.0.0)
     780                     * @since 1.0.0
    782781                     *
    783782                     * @param array  $array             Array holding permalink and content for notification
     
    803802                     * Complete filter - bp_groups_single_membership_request_accepted_notification.
    804803                     *
    805                      * @since BuddyPress (1.0.0)
     804                     * @since 1.0.0
    806805                     *
    807806                     * @param string $string            HTML anchor tag for notification.
     
    818817                     * Complete filter - bp_groups_single_membership_request_accepted_notification.
    819818                     *
    820                      * @since BuddyPress (1.0.0)
     819                     * @since 1.0.0
    821820                     *
    822821                     * @param array  $array             Array holding permalink and content for notification.
     
    853852                     * Complete filter - bp_groups_multiple_membership_request_rejected_notification.
    854853                     *
    855                      * @since BuddyPress (1.0.0)
     854                     * @since 1.0.0
    856855                     *
    857856                     * @param string $string            HTML anchor tag for notification.
     
    868867                     * Complete filter - bp_groups_multiple_membership_request_rejected_notification.
    869868                     *
    870                      * @since BuddyPress (1.0.0)
     869                     * @since 1.0.0
    871870                     *
    872871                     * @param array  $array             Array holding permalink and content for notification.
     
    891890                     * Complete filter - bp_groups_single_membership_request_rejected_notification.
    892891                     *
    893                      * @since BuddyPress (1.0.0)
     892                     * @since 1.0.0
    894893                     *
    895894                     * @param string $string            HTML anchor tag for notification.
     
    906905                     * Complete filter - bp_groups_single_membership_request_rejected_notification.
    907906                     *
    908                      * @since BuddyPress (1.0.0)
     907                     * @since 1.0.0
    909908                     *
    910909                     * @param array  $array             Array holding permalink and content for notification.
     
    940939                     * Complete filter - bp_groups_multiple_member_promoted_to_admin_notification.
    941940                     *
    942                      * @since BuddyPress (1.0.0)
     941                     * @since 1.0.0
    943942                     *
    944943                     * @param string $string            HTML anchor tag for notification.
     
    953952                     * Complete filter - bp_groups_multiple_member_promoted_to_admin_notification.
    954953                     *
    955                      * @since BuddyPress (1.0.0)
     954                     * @since 1.0.0
    956955                     *
    957956                     * @param array  $array             Array holding permalink and content for notification.
     
    974973                     * Complete filter - bp_groups_single_member_promoted_to_admin_notification.
    975974                     *
    976                      * @since BuddyPress (1.0.0)
     975                     * @since 1.0.0
    977976                     *
    978977                     * @param string $string            HTML anchor tag for notification.
     
    988987                     * Complete filter - bp_groups_single_member_promoted_to_admin_notification.
    989988                     *
    990                      * @since BuddyPress (1.0.0)
     989                     * @since 1.0.0
    991990                     *
    992991                     * @param array  $array             Array holding permalink and content for notification.
     
    10221021                     * Complete filter - bp_groups_multiple_member_promoted_to_mod_notification.
    10231022                     *
    1024                      * @since BuddyPress (1.0.0)
     1023                     * @since 1.0.0
    10251024                     *
    10261025                     * @param string $string            HTML anchor tag for notification.
     
    10561055                     * Complete filter - bp_groups_single_member_promoted_to_mod_notification.
    10571056                     *
    1058                      * @since BuddyPress (1.0.0)
     1057                     * @since 1.0.0
    10591058                     *
    10601059                     * @param string $string            HTML anchor tag for notification.
     
    10701069                     * Complete filter - bp_groups_single_member_promoted_to_mod_notification.
    10711070                     *
    1072                      * @since BuddyPress (1.0.0)
     1071                     * @since 1.0.0
    10731072                     *
    10741073                     * @param array  $array             Array holding permalink and content for notification.
     
    11041103                     * Complete filter - bp_groups_multiple_group_invite_notification.
    11051104                     *
    1106                      * @since BuddyPress (1.0.0)
     1105                     * @since 1.0.0
    11071106                     *
    11081107                     * @param string $string            HTML anchor tag for notification.
     
    11171116                     * Complete filter - bp_groups_multiple_group_invite_notification.
    11181117                     *
    1119                      * @since BuddyPress (1.0.0)
     1118                     * @since 1.0.0
    11201119                     *
    11211120                     * @param array  $array             Array holding permalink and content for notification.
     
    11381137                     * Complete filter - bp_groups_single_group_invite_notification.
    11391138                     *
    1140                      * @since BuddyPress (1.0.0)
     1139                     * @since 1.0.0
    11411140                     *
    11421141                     * @param string $string            HTML anchor tag for notification.
     
    11521151                     * Complete filter - bp_groups_single_group_invite_notification.
    11531152                     *
    1154                      * @since BuddyPress (1.0.0)
     1153                     * @since 1.0.0
    11551154                     *
    11561155                     * @param array  $array             Array holding permalink and content for notification.
     
    11741173             * Filters plugin-added group-related custom component_actions.
    11751174             *
    1176              * @since BuddyPress (2.4.0)
     1175             * @since 2.4.0
    11771176             *
    11781177             * @param string $notification      Null value.
     
    11961195     * Fires right before returning the formatted group notifications.
    11971196     *
    1198      * @since BuddyPress (1.0.0)
     1197     * @since 1.0.0
    11991198     *
    12001199     * @param string $action            The type of notification being rendered.
     
    12111210 * Remove all notifications for any member belonging to a specific group.
    12121211 *
    1213  * @since BuddyPress (1.9.0)
     1212 * @since 1.9.0
    12141213 *
    12151214 * @param int $group_id ID of the group.
     
    12251224 * When a demotion takes place, delete any corresponding promotion notifications.
    12261225 *
    1227  * @since BuddyPress (2.0.0)
     1226 * @since 2.0.0
    12281227 *
    12291228 * @param int $user_id  ID of the user.
     
    12411240 * Mark notifications read when a member accepts a group invitation.
    12421241 *
    1243  * @since BuddyPress (1.9.0)
     1242 * @since 1.9.0
    12441243 *
    12451244 * @param int $user_id  ID of the user.
     
    12581257 * Mark notifications read when a member views their group memberships.
    12591258 *
    1260  * @since BuddyPress (1.9.0)
     1259 * @since 1.9.0
    12611260 */
    12621261function bp_groups_screen_my_groups_mark_notifications() {
     
    12821281 * Mark group invitation notifications read when a member views their invitations.
    12831282 *
    1284  * @since BuddyPress (1.9.0)
     1283 * @since 1.9.0
    12851284 */
    12861285function bp_groups_screen_invites_mark_notifications() {
     
    12941293 * Mark group join requests read when an admin or moderator visits the group administration area.
    12951294 *
    1296  * @since BuddyPress (1.9.0)
     1295 * @since 1.9.0
    12971296 */
    12981297function bp_groups_screen_group_admin_requests_mark_notifications() {
     
    13061305 * Delete new group membership notifications when a user is being deleted.
    13071306 *
    1308  * @since BuddyPress (1.9.0)
     1307 * @since 1.9.0
    13091308 *
    13101309 * @param int $user_id ID of the user.
  • trunk/src/bp-groups/bp-groups-screens.php

    r10081 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Screen Functions
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    2524         * Fires before the loading of the Groups directory index.
    2625         *
    27          * @since BuddyPress (1.1.0)
     26         * @since 1.1.0
    2827         */
    2928        do_action( 'groups_directory_groups_setup' );
     
    3231         * Filters the template to load for the Groups directory index.
    3332         *
    34          * @since BuddyPress (1.0.0)
     33         * @since 1.0.0
    3534         *
    3635         * @param string $value Path to the groups directory index template to load.
     
    4948     * Fires before the loading of the My Groups page.
    5049     *
    51      * @since BuddyPress (1.1.0)
     50     * @since 1.1.0
    5251     */
    5352    do_action( 'groups_screen_my_groups' );
     
    5655     * Filters the template to load for the My Groups page.
    5756     *
    58      * @since BuddyPress (1.0.0)
     57     * @since 1.0.0
    5958     *
    6059     * @param string $value Path to the My Groups page template to load.
     
    119118     * Fires before the loading of a users Groups > Invites template.
    120119     *
    121      * @since BuddyPress (1.0.0)
     120     * @since 1.0.0
    122121     *
    123122     * @param int $group_id ID of the group being displayed
     
    128127     * Filters the template to load for a users Groups > Invites page.
    129128     *
    130      * @since BuddyPress (1.0.0)
     129     * @since 1.0.0
    131130     *
    132131     * @param string $value Path to a users Groups > Invites page template.
     
    147146     * Fires before the loading of a single group's page.
    148147     *
    149      * @since BuddyPress (1.0.0)
     148     * @since 1.0.0
    150149     */
    151150    do_action( 'groups_screen_group_home' );
     
    154153     * Filters the template to load for a single group's page.
    155154     *
    156      * @since BuddyPress (1.0.0)
     155     * @since 1.0.0
    157156     *
    158157     * @param string $value Path to a single group's template to load.
     
    243242             * Fires after a group forum topic has been stickied.
    244243             *
    245              * @since BuddyPress (1.1.0)
     244             * @since 1.1.0
    246245             *
    247246             * @param int $topic_id ID of the topic being stickied.
     
    265264             * Fires after a group forum topic has been un-stickied.
    266265             *
    267              * @since BuddyPress (1.1.0)
     266             * @since 1.1.0
    268267             *
    269268             * @param int $topic_id ID of the topic being un-stickied.
     
    287286             * Fires after a group forum topic has been closed.
    288287             *
    289              * @since BuddyPress (1.1.0)
     288             * @since 1.1.0
    290289             *
    291290             * @param int $topic_id ID of the topic being closed.
     
    309308             * Fires after a group forum topic has been opened.
    310309             *
    311              * @since BuddyPress (1.1.0)
     310             * @since 1.1.0
    312311             *
    313312             * @param int $topic_id ID of the topic being opened.
     
    333332             * Fires before a group forum topic is deleted.
    334333             *
    335              * @since BuddyPress (1.5.0)
     334             * @since 1.5.0
    336335             *
    337336             * @param int $topic_id ID of the topic being deleted.
     
    348347             * Fires after a group forum topic has been deleted.
    349348             *
    350              * @since BuddyPress (1.5.0)
     349             * @since 1.5.0
    351350             *
    352351             * @param int $topic_id ID of the topic being deleted.
     
    381380                 * Fires after a group forum topic has been edited.
    382381                 *
    383                  * @since BuddyPress (1.1.0)
     382                 * @since 1.1.0
    384383                 *
    385384                 * @param int $topic_id ID of the topic being edited.
     
    392391             * Filters the template to load for a topic edit page.
    393392             *
    394              * @since BuddyPress (1.1.0)
     393             * @since 1.1.0
    395394             *
    396395             * @param string $value Path to a topic edit template.
     
    414413             * Fires before the deletion of a group forum post.
    415414             *
    416              * @since BuddyPress (1.5.0)
     415             * @since 1.5.0
    417416             *
    418417             * @param int $post_id ID of the forum post being deleted.
     
    429428             * Fires after the deletion of a group forum post.
    430429             *
    431              * @since BuddyPress (1.1.0)
     430             * @since 1.1.0
    432431             *
    433432             * @param int $post_id ID of the forum post being deleted.
     
    466465                 * Fires after the editing of a group forum post.
    467466                 *
    468                  * @since BuddyPress (1.1.0)
     467                 * @since 1.1.0
    469468                 *
    470469                 * @param int $post_id ID of the forum post being edited.
     
    486485             * Filters the template to load for a topic page.
    487486             *
    488              * @since BuddyPress (1.1.0)
     487             * @since 1.1.0
    489488             *
    490489             * @param string $value Path to a topic template.
     
    542541         * Fires at the end of the group forum screen loading process.
    543542         *
    544          * @since BuddyPress (1.0.0)
     543         * @since 1.0.0
    545544         *
    546545         * @param int $topic_id ID of the topic being displayed.
     
    552551         * Filters the template to load for a group forum page.
    553552         *
    554          * @since BuddyPress (1.0.0)
     553         * @since 1.0.0
    555554         *
    556555         * @param string $value Path to a group forum template.
     
    576575     * Fires before the loading of a group's Members page.
    577576     *
    578      * @since BuddyPress (1.0.0)
     577     * @since 1.0.0
    579578     *
    580579     * @param int $id ID of the group whose members are being displayed.
     
    585584     * Filters the template to load for a group's Members page.
    586585     *
    587      * @since BuddyPress (1.0.0)
     586     * @since 1.0.0
    588587     *
    589588     * @param string $value Path to a group's Members template.
     
    620619         * Fires after the sending of a group invite inside the group's Send Invites page.
    621620         *
    622          * @since BuddyPress (1.0.0)
     621         * @since 1.0.0
    623622         *
    624623         * @param int $id ID of the group whose members are being displayed.
     
    632631         * Filters the template to load for a group's Send Invites page.
    633632         *
    634          * @since BuddyPress (1.0.0)
     633         * @since 1.0.0
    635634         *
    636635         * @param string $value Path to a group's Send Invites template.
     
    649648 * Remove Invite removes the invitation via AJAX.
    650649 *
    651  * @since BuddyPress (2.0.0)
     650 * @since 2.0.0
    652651 */
    653652function groups_remove_group_invite() {
     
    726725     * Fires before the loading of a group's Request Memebership page.
    727726     *
    728      * @since BuddyPress (1.0.0)
     727     * @since 1.0.0
    729728     *
    730729     * @param int $id ID of the group currently being displayed.
     
    735734     * Filters the template to load for a group's Request Membership page.
    736735     *
    737      * @since BuddyPress (1.0.0)
     736     * @since 1.0.0
    738737     *
    739738     * @param string $value Path to a group's Request Membership template.
     
    799798             * Fires before the redirect if a group details has been edited and saved.
    800799             *
    801              * @since BuddyPress (1.0.0)
     800             * @since 1.0.0
    802801             *
    803802             * @param int $id ID of the group that was edited.
     
    811810         * Fires before the loading of the group admin/edit-details page template.
    812811         *
    813          * @since BuddyPress (1.0.0)
     812         * @since 1.0.0
    814813         *
    815814         * @param int $id ID of the group that is being displayed.
     
    820819         * Filters the template to load for a group's admin/edit-details page.
    821820         *
    822          * @since BuddyPress (1.0.0)
     821         * @since 1.0.0
    823822         *
    824823         * @param string $value Path to a group's admin/edit-details template.
     
    869868         * Fires before the redirect if a group settings has been edited and saved.
    870869         *
    871          * @since BuddyPress (1.0.0)
     870         * @since 1.0.0
    872871         *
    873872         * @param int $id ID of the group that was edited.
     
    881880     * Fires before the loading of the group admin/group-settings page template.
    882881     *
    883      * @since BuddyPress (1.0.0)
     882     * @since 1.0.0
    884883     *
    885884     * @param int $id ID of the group that is being displayed.
     
    890889     * Filters the template to load for a group's admin/group-settings page.
    891890     *
    892      * @since BuddyPress (1.0.0)
     891     * @since 1.0.0
    893892     *
    894893     * @param string $value Path to a group's admin/group-settings template.
     
    973972     * Fires before the loading of the group Change Avatar page template.
    974973     *
    975      * @since BuddyPress (1.0.0)
     974     * @since 1.0.0
    976975     *
    977976     * @param int $id ID of the group that is being displayed.
     
    982981     * Filters the template to load for a group's Change Avatar page.
    983982     *
    984      * @since BuddyPress (1.0.0)
     983     * @since 1.0.0
    985984     *
    986985     * @param string $value Path to a group's Change Avatar template.
     
    10211020             * Fires before the redirect after a group member has been promoted.
    10221021             *
    1023              * @since BuddyPress (1.0.0)
     1022             * @since 1.0.0
    10241023             *
    10251024             * @param int $user_id ID of the user being promoted.
     
    10541053             * Fires before the redirect after a group member has been demoted.
    10551054             *
    1056              * @since BuddyPress (1.0.0)
     1055             * @since 1.0.0
    10571056             *
    10581057             * @param int $user_id ID of the user being demoted.
     
    10801079             * Fires before the redirect after a group member has been banned.
    10811080             *
    1082              * @since BuddyPress (1.0.0)
     1081             * @since 1.0.0
    10831082             *
    10841083             * @param int $user_id ID of the user being banned.
     
    11061105             * Fires before the redirect after a group member has been unbanned.
    11071106             *
    1108              * @since BuddyPress (1.0.0)
     1107             * @since 1.0.0
    11091108             *
    11101109             * @param int $user_id ID of the user being unbanned.
     
    11321131             * Fires before the redirect after a group member has been removed.
    11331132             *
    1134              * @since BuddyPress (1.2.6)
     1133             * @since 1.2.6
    11351134             *
    11361135             * @param int $user_id ID of the user being removed.
     
    11461145     * Fires before the loading of a group's manage members template.
    11471146     *
    1148      * @since BuddyPress (1.0.0)
     1147     * @since 1.0.0
    11491148     *
    11501149     * @param int $id ID of the group whose manage members page is being displayed.
     
    11551154     * Filters the template to load for a group's manage members page.
    11561155     *
    1157      * @since BuddyPress (1.0.0)
     1156     * @since 1.0.0
    11581157     *
    11591158     * @param string $value Path to a group's manage members template.
     
    12081207         * Fires before the redirect if a group membership request has been handled.
    12091208         *
    1210          * @since BuddyPress (1.0.0)
     1209         * @since 1.0.0
    12111210         *
    12121211         * @param int    $id             ID of the group that was edited.
     
    12211220     * Fires before the loading of the group membership request page template.
    12221221     *
    1223      * @since BuddyPress (1.0.0)
     1222     * @since 1.0.0
    12241223     *
    12251224     * @param int $id ID of the group that is being displayed.
     
    12301229     * Filters the template to load for a group's membership request page.
    12311230     *
    1232      * @since BuddyPress (1.0.0)
     1231     * @since 1.0.0
    12331232     *
    12341233     * @param string $value Path to a group's membership request template.
     
    12611260         * Fires before the deletion of a group from the Delete Group page.
    12621261         *
    1263          * @since BuddyPress (1.5.0)
     1262         * @since 1.5.0
    12641263         *
    12651264         * @param int $id ID of the group being deleted.
     
    12761275             * Fires after the deletion of a group from the Delete Group page.
    12771276             *
    1278              * @since BuddyPress (1.0.0)
     1277             * @since 1.0.0
    12791278             *
    12801279             * @param int $id ID of the group being deleted.
     
    12911290     * Fires before the loading of the Delete Group page template.
    12921291     *
    1293      * @since BuddyPress (1.0.0)
     1292     * @since 1.0.0
    12941293     *
    12951294     * @param int $id ID of the group that is being displayed.
     
    13001299     * Filters the template to load for the Delete Group page.
    13011300     *
    1302      * @since BuddyPress (1.0.0)
     1301     * @since 1.0.0
    13031302     *
    13041303     * @param string $value Path to the Delete Group template.
     
    13661365             * Fires at the end of the available group settings fields on Notification Settings page.
    13671366             *
    1368              * @since BuddyPress (1.0.0)
     1367             * @since 1.0.0
    13691368             */
    13701369            do_action( 'groups_screen_notification_settings' ); ?>
     
    13851384 * group template parts to the_title and the_content areas of a theme.
    13861385 *
    1387  * @since BuddyPress (1.7.0)
     1386 * @since 1.7.0
    13881387 */
    13891388class BP_Groups_Theme_Compat {
     
    13921391     * Set up theme compatibility for the Groups component.
    13931392     *
    1394      * @since BuddyPress (1.7.0)
     1393     * @since 1.7.0
    13951394     */
    13961395    public function __construct() {
     
    14011400     * Are we looking at something that needs group theme compatibility?
    14021401     *
    1403      * @since BuddyPress (1.7.0)
     1402     * @since 1.7.0
    14041403     */
    14051404    public function is_group() {
     
    14161415             * Fires at the start of the group theme compatibility setup.
    14171416             *
    1418              * @since BuddyPress (1.1.0)
     1417             * @since 1.1.0
    14191418             */
    14201419            do_action( 'groups_directory_groups_setup' );
     
    14471446     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    14481447     *
    1449      * @since BuddyPress (1.8.0)
     1448     * @since 1.8.0
    14501449     *
    14511450     * @param string $templates The templates from bp_get_theme_compat_templates().
     
    14571456         * Filters the Groups directory page template hierarchy based on priority.
    14581457         *
    1459          * @since BuddyPress (1.8.0)
     1458         * @since 1.8.0
    14601459         *
    14611460         * @param array $value Array of default template files to use.
     
    14751474     * Update the global $post with directory data.
    14761475     *
    1477      * @since BuddyPress (1.7.0)
     1476     * @since 1.7.0
    14781477     */
    14791478    public function directory_dummy_post() {
     
    14941493     * Filter the_content with the groups index template part.
    14951494     *
    1496      * @since BuddyPress (1.7.0)
     1495     * @since 1.7.0
    14971496     */
    14981497    public function directory_content() {
     
    15081507     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    15091508     *
    1510      * @since BuddyPress (1.8.0)
     1509     * @since 1.8.0
    15111510     *
    15121511     * @param string $templates The templates from bp_get_theme_compat_templates().
     
    15191518         * Filters the Groups create page template hierarchy based on priority.
    15201519         *
    1521          * @since BuddyPress (1.8.0)
     1520         * @since 1.8.0
    15221521         *
    15231522         * @param array $value Array of default template files to use.
     
    15371536     * Update the global $post with create screen data.
    15381537     *
    1539      * @since BuddyPress (1.7.0)
     1538     * @since 1.7.0
    15401539     */
    15411540    public function create_dummy_post() {
     
    15591558     * Filter the_content with the create screen template part.
    15601559     *
    1561      * @since BuddyPress (1.7.0)
     1560     * @since 1.7.0
    15621561     */
    15631562    public function create_content() {
     
    15731572     * {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    15741573     *
    1575      * @since BuddyPress (1.8.0)
     1574     * @since 1.8.0
    15761575     *
    15771576     * @param string $templates The templates from bp_get_theme_compat_templates().
     
    15851584         * Filters the Groups single pages template hierarchy based on priority.
    15861585         *
    1587          * @since BuddyPress (1.8.0)
     1586         * @since 1.8.0
    15881587         *
    15891588         * @param array $value Array of default template files to use.
     
    16071606     * Update the global $post with single group data.
    16081607     *
    1609      * @since BuddyPress (1.7.0)
     1608     * @since 1.7.0
    16101609     */
    16111610    public function single_dummy_post() {
     
    16261625     * Filter the_content with the single group template part.
    16271626     *
    1628      * @since BuddyPress (1.7.0)
     1627     * @since 1.7.0
    16291628     */
    16301629    public function single_content() {
  • trunk/src/bp-groups/bp-groups-template.php

    r10126 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Template Functions.
    5  */
    6 
    7 // Exit if accessed directly
     4 *
     5 * @package BuddyPress
     6 * @subpackage GroupsTemplates
     7 */
     8
     9// Exit if accessed directly.
    810defined( 'ABSPATH' ) || exit;
    911
     
    1113 * Output the groups component slug.
    1214 *
    13  * @since BuddyPress (1.5.0)
     15 * @since 1.5.0
    1416 */
    1517function bp_groups_slug() {
     
    1921     * Return the groups component slug.
    2022     *
    21      * @since BuddyPress (1.5.0)
     23     * @since 1.5.0
    2224     *
    2325     * @return string
     
    2830         * Filters the groups component slug.
    2931         *
    30          * @since BuddyPress (1.5.0)
     32         * @since 1.5.0
    3133         *
    3234         * @param string $slug Groups component slug.
     
    3840 * Output the groups component root slug.
    3941 *
    40  * @since BuddyPress (1.5.0)
     42 * @since 1.5.0
    4143 */
    4244function bp_groups_root_slug() {
     
    4648     * Return the groups component root slug.
    4749     *
    48      * @since BuddyPress (1.5.0)
     50     * @since 1.5.0
    4951     *
    5052     * @return string
     
    5557         * Filters the groups component root slug.
    5658         *
    57          * @since BuddyPress (1.5.0)
     59         * @since 1.5.0
    5860         *
    5961         * @param string $root_slug Groups component root slug.
     
    6567 * Output group directory permalink.
    6668 *
    67  * @since BuddyPress (1.5.0)
     69 * @since 1.5.0
    6870 */
    6971function bp_groups_directory_permalink() {
     
    7375     * Return group directory permalink.
    7476     *
    75      * @since BuddyPress (1.5.0)
     77     * @since 1.5.0
    7678     *
    7779     * @return string
     
    8284         * Filters the group directory permalink.
    8385         *
    84          * @since BuddyPress (1.5.0)
     86         * @since 1.5.0
    8587         *
    8688         * @param string $value Permalink for the group directory.
     
    427429             * Fires right before the rewinding of groups list.
    428430             *
    429              * @since BuddyPress (1.5.0)
     431             * @since 1.5.0
    430432             */
    431433            do_action('group_loop_end');
     
    456458             * Fires if the current group item is the first in the loop.
    457459             *
    458              * @since BuddyPress (1.1.0)
     460             * @since 1.1.0
    459461             */
    460462            do_action( 'group_loop_start' );
     
    466468 * Start the Groups Template Loop.
    467469 *
    468  * @since BuddyPress (1.0.0)
     470 * @since 1.0.0
    469471 *
    470472 * @param array|string $args {
     
    587589     * Filters whether or not there are groups to iterate over for the groups loop.
    588590     *
    589      * @since BuddyPress (1.1.0)
     591     * @since 1.1.0
    590592     *
    591593     * @param bool               $value           Whether or not there are groups to iterate over.
     
    671673         * Filters the ID of the current group in the loop.
    672674         *
    673          * @since BuddyPress (1.0.0)
     675         * @since 1.0.0
    674676         *
    675677         * @param int $id ID of the current group in the loop.
     
    681683 * Output the row class of the current group in the loop.
    682684 *
    683  * @since BuddyPress (1.7.0)
     685 * @since 1.7.0
    684686 *
    685687 * @param array $classes Array of custom classes.
     
    691693     * Get the row class of the current group in the loop.
    692694     *
    693      * @since BuddyPress (1.7.0)
     695     * @since 1.7.0
    694696     *
    695697     * @param array $classes Array of custom classes.
     
    742744         * Filters classes that will be applied to row class of the current group in the loop.
    743745         *
    744          * @since BuddyPress (1.7.0)
     746         * @since 1.7.0
    745747         *
    746748         * @param array $classes Array of determined classes for the row.
     
    780782         * Filters the name of the current group in the loop.
    781783         *
    782          * @since BuddyPress (1.0.0)
     784         * @since 1.0.0
    783785         *
    784786         * @param string $name Name of the current group in the loop.
     
    825827     * Filters the type for the current group in the loop.
    826828     *
    827      * @since BuddyPress (1.0.0)
     829     * @since 1.0.0
    828830     *
    829831     * @param string $type Type for the current group in the loop.
     
    858860         * Filters the status of the current group in the loop.
    859861         *
    860          * @since BuddyPress (1.0.0)
     862         * @since 1.0.0
    861863         *
    862864         * @param string $status Status of the current group in the loop.
     
    868870 * Output the group avatar while in the groups loop.
    869871 *
    870  * @since BuddyPress (1.0.0)
     872 * @since 1.0.0
    871873 *
    872874 * @param array|string $args {
     
    880882     * Get a group's avatar.
    881883     *
    882      * @since BuddyPress (1.0.0)
     884     * @since 1.0.0
    883885     *
    884886     * @see bp_core_fetch_avatar() For a description of arguments and return values.
     
    937939         * Filters the group avatar while in the groups loop.
    938940         *
    939          * @since BuddyPress (1.0.0)
     941         * @since 1.0.0
    940942         *
    941943         * @param string $avatar HTML image element holding the group avatar.
     
    948950 * Output the group avatar thumbnail while in the groups loop.
    949951 *
    950  * @since BuddyPress (1.0.0)
     952 * @since 1.0.0
    951953 *
    952954 * @param object|bool $group Optional. Group object.
     
    959961     * Return the group avatar thumbnail while in the groups loop.
    960962     *
    961      * @since BuddyPress (1.0.0)
     963     * @since 1.0.0
    962964     *
    963965     * @param object|bool $group Optional. Group object.
     
    976978 * Output the miniature group avatar thumbnail while in the groups loop.
    977979 *
    978  * @since BuddyPress (1.0.0)
     980 * @since 1.0.0
    979981 *
    980982 * @param object|bool $group Optional. Group object.
     
    987989     * Return the miniature group avatar thumbnail while in the groups loop.
    988990     *
    989      * @since BuddyPress (1.0.0)
     991     * @since 1.0.0
    990992     *
    991993     * @param object|bool $group Optional. Group object.
     
    10401042             * Filters the 'last active' string for the current gorup in the loop.
    10411043             *
    1042              * @since BuddyPress (1.0.0)
     1044             * @since 1.0.0
    10431045             *
    10441046             * @param string $value Determined last active value for the current group.
     
    10751077         * Filters the permalink for the current group in the loop.
    10761078         *
    1077          * @since BuddyPress (1.0.0)
     1079         * @since 1.0.0
    10781080         *
    10791081         * @param string $value Permalink for the current group in the loop.
     
    11091111         * Filters the permalink for the admin section of the current group in the loop.
    11101112         *
    1111          * @since BuddyPress (1.0.0)
     1113         * @since 1.0.0
    11121114         *
    11131115         * @param string $value Permalink for the admin section of the current group in the loop.
     
    11431145         * Filters the slug for the current group in the loop.
    11441146         *
    1145          * @since BuddyPress (1.0.0)
     1147         * @since 1.0.0
    11461148         *
    11471149         * @param string $slug Slug for the current group in the loop.
     
    11771179         * Filters the description for the current group in the loop.
    11781180         *
    1179          * @since BuddyPress (1.0.0)
     1181         * @since 1.0.0
    11801182         *
    11811183         * @param string $value Description for the current group.
     
    12191221         * appropriate for "raw" editing.
    12201222         *
    1221          * @since BuddyPress (1.0.0)
     1223         * @since 1.0.0
    12221224         *
    12231225         * @param string $description Description for the current group in the loop.
     
    12551257         * Filters the excerpt of a group description.
    12561258         *
    1257          * @since BuddyPress (1.0.0)
     1259         * @since 1.0.0
    12581260         *
    12591261         * @param string $value Excerpt of a group description.
     
    13561358         * Filters the created date of the current group in the loop.
    13571359         *
    1358          * @since BuddyPress (1.0.0)
     1360         * @since 1.0.0
    13591361         *
    13601362         * @param string $value Created date for the current group.
     
    13901392         * Filters the username of the creator of the current group in the loop.
    13911393         *
    1392          * @since BuddyPress (1.7.0)
     1394         * @since 1.7.0
    13931395         *
    13941396         * @param string $value Username of the group creator.
     
    14241426         * Filters the user ID of the creator of the current group in the loop.
    14251427         *
    1426          * @since BuddyPress (1.7.0)
     1428         * @since 1.7.0
    14271429         *
    14281430         * @param int $creator_id User ID of the group creator.
     
    14581460         * Filters the permalink of the creator of the current group in the loop.
    14591461         *
    1460          * @since BuddyPress (1.7.0)
     1462         * @since 1.7.0
    14611463         *
    14621464         * @param string $value Permalink of the group creator.
     
    15431545         * Filters the avatar of the creator of the current group in the loop.
    15441546         *
    1545          * @since BuddyPress (1.7.0)
     1547         * @since 1.7.0
    15461548         *
    15471549         * @param string $avatar Avatar of the group creator.
     
    16631665 * Return a list of user IDs for a group's admins.
    16641666 *
    1665  * @since BuddyPress (1.5.0)
     1667 * @since 1.5.0
    16661668 *
    16671669 * @param BP_Groups_Group|bool $group     Optional. The group being queried. Defaults
     
    16951697     * This filter may return either an array or a comma separated string.
    16961698     *
    1697      * @since BuddyPress (1.5.0)
     1699     * @since 1.5.0
    16981700     *
    16991701     * @param array|string $admin_ids List of user IDs for a group's admins.
     
    17051707 * Return a list of user IDs for a group's moderators.
    17061708 *
    1707  * @since BuddyPress (1.5.0)
     1709 * @since 1.5.0
    17081710 *
    17091711 * @param BP_Groups_Group|bool $group   Optional. The group being queried.
     
    17371739     * This filter may return either an array or a comma separated string.
    17381740     *
    1739      * @since BuddyPress (1.5.0)
     1741     * @since 1.5.0
    17401742     *
    17411743     * @param array|string $admin_ids List of user IDs for a group's moderators.
     
    17681770         * Filters the permalink of the Members page for the current group in the loop.
    17691771         *
    1770          * @since BuddyPress (1.0.0)
     1772         * @since 1.0.0
    17711773         *
    17721774         * @param string $value Permalink of the Members page for the current group.
     
    18501852         * Filters the pagination HTML for a group loop.
    18511853         *
    1852          * @since BuddyPress (1.2.0)
     1854         * @since 1.2.0
    18531855         *
    18541856         * @param string $pag_links HTML markup for the pagination links.
     
    18851887         * Filters the "Viewing x-y of z groups" pagination message.
    18861888         *
    1887          * @since BuddyPress (1.5.0)
     1889         * @since 1.5.0
    18881890         *
    18891891         * @param string $message  "Viewing x-y of z groups" text.
     
    19411943         * Filters the total member count for a group.
    19421944         *
    1943          * @since BuddyPress (1.0.0)
     1945         * @since 1.0.0
    19441946         *
    19451947         * @param int $total_member_count Total member count for a group.
     
    19731975         * Filters the "x members" count string for a group.
    19741976         *
    1975          * @since BuddyPress (1.2.0)
     1977         * @since 1.2.0
    19761978         *
    19771979         * @param string $count_string The "x members" count string for a group.
     
    20042006         * Filters the URL of the Forum page of a group.
    20052007         *
    2006          * @since BuddyPress (1.0.0)
     2008         * @since 1.0.0
    20072009         *
    20082010         * @param string $value URL permalink for the Forum Page.
     
    20652067         * Filters the topic count string for a group forum.
    20662068         *
    2067          * @since BuddyPress (1.2.0)
     2069         * @since 1.2.0
    20682070         *
    20692071         * @param string $total_topics Total topic count string.
     
    21272129         * Filters the post count string for a group forum.
    21282130         *
    2129          * @since BuddyPress (1.2.0)
     2131         * @since 1.2.0
    21302132         *
    21312133         * @param string $total_posts Total post count string.
     
    21942196 * Output the 'checked' value, if needed, for a given invite_status on the group create/admin screens
    21952197 *
    2196  * @since BuddyPress (1.5.0)
     2198 * @since 1.5.0
    21972199 *
    21982200 * @param string      $setting The setting you want to check against ('members',
     
    22212223 * This function can be used either in or out of the loop.
    22222224 *
    2223  * @since BuddyPress (1.5.0)
     2225 * @since 1.5.0
    22242226 *
    22252227 * @param int|bool $group_id Optional. The ID of the group whose status you want to
     
    22602262     * Invite status in this case means who from the group can send invites.
    22612263     *
    2262      * @since BuddyPress (1.5.0)
     2264     * @since 1.5.0
    22632265     *
    22642266     * @param string $invite_status Membership level needed to send an invite.
     
    22712273 * Can a user send invitations in the specified group?
    22722274 *
    2273  * @since BuddyPress (1.5.0)
    2274  * @since BuddyPress (2.2.0) Added the $user_id parameter.
     2275 * @since 1.5.0
     2276 * @since 2.2.0 Added the $user_id parameter.
    22752277 *
    22762278 * @param int $group_id The group ID to check.
     
    23242326     * Filters whether a user can send invites in a group.
    23252327     *
    2326      * @since BuddyPress (1.5.0)
    2327      * @since BuddyPress (2.2.0) Added the $user_id parameter.
     2328     * @since 1.5.0
     2329     * @since 2.2.0 Added the $user_id parameter.
    23282330     *
    23292331     * @param bool $can_send_invites Whether the user can send invites
     
    23412343 * @deprecated 1.5
    23422344 * @deprecated No longer used.
    2343  * @since BuddyPress (1.0.0)
     2345 * @since 1.0.0
    23442346 * @todo Remove in 1.4
    23452347 *
     
    25062508     * Filters whether a group has moderators.
    25072509     *
    2508      * @since BuddyPress (1.0.0)
     2510     * @since 1.0.0
    25092511     *
    25102512     * @param array $value Array of user IDs who are a moderator of the provided group.
     
    25452547         * Filters a URL for promoting a user to moderator.
    25462548         *
    2547          * @since BuddyPress (1.1.0)
     2549         * @since 1.1.0
    25482550         *
    25492551         * @param string $value URL to use for promoting a user to moderator.
     
    25842586         * Filters a URL for promoting a user to admin.
    25852587         *
    2586          * @since BuddyPress (1.1.0)
     2588         * @since 1.1.0
    25872589         *
    25882590         * @param string $value URL to use for promoting a user to admin.
     
    26292631         * Filters a URL for demoting a user to member.
    26302632         *
    2631          * @since BuddyPress (1.0.0)
     2633         * @since 1.0.0
    26322634         *
    26332635         * @param string $value URL to use for demoting a user to member.
     
    26702672         * Filters a URL for banning a member from a group.
    26712673         *
    2672          * @since BuddyPress (1.0.0)
     2674         * @since 1.0.0
    26732675         *
    26742676         * @param string $value URL to use for banning a member.
     
    27152717         * Filters a URL for unbanning a member from a group.
    27162718         *
    2717          * @since BuddyPress (1.0.0)
     2719         * @since 1.0.0
    27182720         *
    27192721         * @param string $value URL to use for unbanning a member.
     
    27562758         * Filters a URL for removing a member from a group.
    27572759         *
    2758          * @since BuddyPress (1.2.6)
     2760         * @since 1.2.6
    27592761         *
    27602762         * @param string $value URL to use for removing a member.
     
    28372839         * FIlters the group count for a displayed user.
    28382840         *
    2839          * @since BuddyPress (1.1.0)
     2841         * @since 1.1.0
    28402842         *
    28412843         * @param int $value Total group count for a displayed user.
     
    28712873         * Filters the 'action' attribute for a group form.
    28722874         *
    2873          * @since BuddyPress (1.0.0)
     2875         * @since 1.0.0
    28742876         *
    28752877         * @param string $value Action attribute for a group form.
     
    29092911         * Filters the 'action' attribute for a group admin form.
    29102912         *
    2911          * @since BuddyPress (1.0.0)
     2913         * @since 1.0.0
    29122914         *
    29132915         * @param string $value Action attribute for a group admin form.
     
    29632965     * Filters whether current user is member of a group.
    29642966     *
    2965      * @since BuddyPress (1.2.4)
     2967     * @since 1.2.4
    29662968     *
    29672969     * @param bool $is_member If user is a member of group or not.
     
    29882990     * Filters whether current user has an outstanding invite to current group in loop.
    29892991     *
    2990      * @since BuddyPress (2.1.0)
     2992     * @since 2.1.0
    29912993     *
    29922994     * @param bool $is_invited If user has an outstanding group invite.
     
    30083010 * capability, the return value would be boolean false.
    30093011 *
    3010  * @since BuddyPress (1.5.0)
     3012 * @since 1.5.0
    30113013 *
    30123014 * @global BP_Groups_Template $groups_template Group template loop object.
     
    30513053     * Filters whether current user has been banned from current group in loop.
    30523054     *
    3053      * @since BuddyPress (1.5.0)
     3055     * @since 1.5.0
    30543056     *
    30553057     * @param bool $is_invited If user has been from current group.
     
    30843086         * Filters the URL for accepting an invitation to a group.
    30853087         *
    3086          * @since BuddyPress (1.0.0)
     3088         * @since 1.0.0
    30873089         *
    30883090         * @param string $value URL for accepting an invitation to a group.
     
    31173119         * Filters the URL for rejecting an invitation to a group.
    31183120         *
    3119          * @since BuddyPress (1.0.0)
     3121         * @since 1.0.0
    31203122         *
    31213123         * @param string $value URL for rejecting an invitation to a group.
     
    31483150         * Filters the URL for confirming a request to leave a group.
    31493151         *
    3150          * @since BuddyPress (1.0.0)
     3152         * @since 1.0.0
    31513153         *
    31523154         * @param string $value URL for confirming a request to leave a group.
     
    31793181         * Filters the URL for rejecting a request to leave a group.
    31803182         *
    3181          * @since BuddyPress (1.0.0)
     3183         * @since 1.0.0
    31823184         *
    31833185         * @param string $value URL for rejecting a request to leave a group.
     
    32103212         * Filters the 'action' attribute for a group send invite form.
    32113213         *
    3212          * @since BuddyPress (1.0.0)
     3214         * @since 1.0.0
    32133215         *
    32143216         * @param string $value Action attribute for a group send invite form.
     
    32463248 * Output a 'New Topic' button for a group.
    32473249 *
    3248  * @since BuddyPress (1.2.7)
     3250 * @since 1.2.7
    32493251 *
    32503252 * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed,
     
    32583260     * Returns a 'New Topic' button for a group.
    32593261     *
    3260      * @since BuddyPress (1.2.7)
     3262     * @since 1.2.7
    32613263     *
    32623264     * @param BP_Groups_Group|bool $group The BP Groups_Group object if
     
    32923294         * Filters the HTML button for creating a new topic in a group.
    32933295         *
    3294          * @since BuddyPress (1.5.0)
     3296         * @since 1.5.0
    32953297         *
    32963298         * @param string $button HTML button for a new topic.
     
    33023304 * Output button to join a group.
    33033305 *
    3304  * @since BuddyPress (1.0.0)
     3306 * @since 1.0.0
    33053307 *
    33063308 * @param object|bool $group Single group object.
     
    33123314     * Return button to join a group.
    33133315     *
    3314      * @since BuddyPress (1.0.0)
     3316     * @since 1.0.0
    33153317     *
    33163318     * @param object|bool $group Single group object.
     
    34403442         * Filters the HTML button for joining a group.
    34413443         *
    3442          * @since BuddyPress (1.2.6)
    3443          * @since BuddyPress (2.4.0) Added $group parameter to filter args.
     3444         * @since 1.2.6
     3445         * @since 2.4.0 Added $group parameter to filter args.
    34443446         *
    34453447         * @param string $button HTML button for joining a group.
     
    34523454 * Output the Create a Group button.
    34533455 *
    3454  * @since BuddyPress (2.0.0)
     3456 * @since 2.0.0
    34553457 */
    34563458function bp_group_create_button() {
     
    34603462     * Get the Create a Group button.
    34613463     *
    3462      * @since BuddyPress (2.0.0)
     3464     * @since 2.0.0
    34633465     *
    34643466     * @return string
     
    34873489         * Filters the HTML button for creating a group.
    34883490         *
    3489          * @since BuddyPress (2.0.0)
     3491         * @since 2.0.0
    34903492         *
    34913493         * @param string $button HTML button for creating a group.
     
    34973499 * Output the Create a Group nav item.
    34983500 *
    3499  * @since BuddyPress (2.2.0)
     3501 * @since 2.2.0
    35003502 */
    35013503function bp_group_create_nav_item() {
     
    35063508     * Get the Create a Group nav item.
    35073509     *
    3508      * @since BuddyPress (2.2.0)
     3510     * @since 2.2.0
    35093511     *
    35103512     * @return string
     
    35243526         * Filters the Create a Group nav item.
    35253527         *
    3526          * @since BuddyPress (2.2.0)
     3528         * @since 2.2.0
    35273529         *
    35283530         * @param string $output HTML output for nav item.
     
    35353537 * if so, transform the title button into a Groups directory nav item.
    35363538 *
    3537  * @since BuddyPress (2.2.0)
     3539 * @since 2.2.0
    35383540 *
    35393541 * @uses   bp_group_create_nav_item() to output the create a Group nav item.
     
    35593561 * hidden or private group, and the user does not have access).
    35603562 *
    3561  * @since BuddyPress (1.0.0)
     3563 * @since 1.0.0
    35623564 *
    35633565 * @global BP_Groups_Template $groups_template Groups template object.
     
    36113613     * This will be true if it is a hidden or private group, and the user does not have access.
    36123614     *
    3613      * @since BuddyPress (1.6.0)
     3615     * @since 1.6.0
    36143616     *
    36153617     * @param string $message Message to display to the current user.
     
    36243626 * This function is no longer used, but may still be used by older themes.
    36253627 *
    3626  * @since BuddyPress (1.0.0)
     3628 * @since 1.0.0
    36273629 */
    36283630function bp_group_hidden_fields() {
     
    36433645 * Output the total number of groups.
    36443646 *
    3645  * @since BuddyPress (1.0.0)
     3647 * @since 1.0.0
    36463648 */
    36473649function bp_total_group_count() {
     
    36513653     * Return the total number of groups.
    36523654     *
    3653      * @since BuddyPress (1.0.0)
     3655     * @since 1.0.0
    36543656     * @return type
    36553657     */
     
    36593661         * Filters the total number of groups.
    36603662         *
    3661          * @since BuddyPress (1.0.0)
     3663         * @since 1.0.0
    36623664         *
    36633665         * @param int $value Total number of groups found.
     
    36693671 * Output the total number of groups a user belongs to.
    36703672 *
    3671  * @since BuddyPress (1.0.0)
     3673 * @since 1.0.0
    36723674 *
    36733675 * @param int $user_id User ID to get group membership count.
     
    36813683     * Filtered by `bp_core_number_format()` by default
    36823684     *
    3683      * @since BuddyPress (1.0.0)
     3685     * @since 1.0.0
    36843686     *
    36853687     * @param int $user_id User ID to get group membership count.
     
    36933695         * Filters the total number of groups a user belongs to.
    36943696         *
    3695          * @since BuddyPress (1.2.0)
     3697         * @since 1.2.0
    36963698         *
    36973699         * @param int $count   Total number of groups for the user.
     
    38553857             * Fires right before the rewinding of members list.
    38563858             *
    3857              * @since BuddyPress (1.0.0)
    3858              * @since BuddyPress (2.3.0) `$this` parameter added.
     3859             * @since 1.0.0
     3860             * @since 2.3.0 `$this` parameter added.
    38593861             *
    38603862             * @param BP_Groups_Group_Members_Template $this Instance of the current Members template.
     
    38803882             * Fires if the current member item is the first in the members list.
    38813883             *
    3882              * @since BuddyPress (1.0.0)
    3883              * @since BuddyPress (2.3.0) `$this` parameter added.
     3884             * @since 1.0.0
     3885             * @since 2.3.0 `$this` parameter added.
    38843886             *
    38853887             * @param BP_Groups_Group_Members_Template $this Instance of the current Members template.
     
    39483950     * Filters whether or not a group member query has members to display.
    39493951     *
    3950      * @since BuddyPress (1.1.0)
     3952     * @since 1.1.0
    39513953     *
    39523954     * @param bool                             $value            Whether there are members to display.
     
    39713973 * Output the group member avatar while in the groups members loop.
    39723974 *
    3973  * @since BuddyPress (1.0.0)
     3975 * @since 1.0.0
    39743976 *
    39753977 * @param array|string $args {@see bp_core_fetch_avatar()}
     
    39813983     * Return the group member avatar while in the groups members loop.
    39823984     *
    3983      * @since BuddyPress (1.0.0)
     3985     * @since 1.0.0
    39843986     *
    39853987     * @param array|string $args {@see bp_core_fetch_avatar()}
     
    40004002         * Filters the group member avatar while in the groups members loop.
    40014003         *
    4002          * @since BuddyPress (1.0.0)
     4004         * @since 1.0.0
    40034005         *
    40044006         * @param string $value HTML markup for group member avatar.
     
    40114013 * Output the group member avatar while in the groups members loop.
    40124014 *
    4013  * @since BuddyPress (1.0.0)
     4015 * @since 1.0.0
    40144016 *
    40154017 * @param array|string $args {@see bp_core_fetch_avatar()}
     
    40224024     * Return the group member avatar while in the groups members loop.
    40234025     *
    4024      * @since BuddyPress (1.0.0)
     4026     * @since 1.0.0
    40254027     *
    40264028     * @param array|string $args {@see bp_core_fetch_avatar()}
     
    40414043         * Filters the group member avatar thumb while in the groups members loop.
    40424044         *
    4043          * @since BuddyPress (1.1.0)
     4045         * @since 1.1.0
    40444046         *
    40454047         * @param string $value HTML markup for group member avatar thumb.
     
    40524054 * Output the group member avatar while in the groups members loop.
    40534055 *
    4054  * @since BuddyPress (1.0.0)
     4056 * @since 1.0.0
    40554057 *
    40564058 * @param int $width  Width of avatar to fetch.
     
    40634065     * Output the group member avatar while in the groups members loop.
    40644066     *
    4065      * @since BuddyPress (1.0.0)
     4067     * @since 1.0.0
    40664068     *
    40674069     * @param int $width  Width of avatar to fetch.
     
    40854087         * Filters the group member avatar mini while in the groups members loop.
    40864088         *
    4087          * @since BuddyPress (1.0.0)
     4089         * @since 1.0.0
    40884090         *
    40894091         * @param string $value HTML markup for group member avatar mini.
     
    41024104         * Filters the group member display name of the current user in the loop.
    41034105         *
    4104          * @since BuddyPress (1.0.0)
     4106         * @since 1.0.0
    41054107         *
    41064108         * @param string $display_name Display name of the current user.
     
    41184120         * Filters the group member url for the current user in the loop.
    41194121         *
    4120          * @since BuddyPress (1.0.0)
     4122         * @since 1.0.0
    41214123         *
    41224124         * @param string $value URL for the current user.
     
    41344136         * Filters the group member HTML link for the current user in the loop.
    41354137         *
    4136          * @since BuddyPress (1.0.0)
     4138         * @since 1.0.0
    41374139         *
    41384140         * @param string $value HTML link for the current user.
     
    41504152         * Filters the group member domain for the current user in the loop.
    41514153         *
    4152          * @since BuddyPress (1.2.0)
     4154         * @since 1.2.0
    41534155         *
    41544156         * @param string $value Domain for the current user.
     
    41744176         * Filters the friendship status between current user and displayed user in group member loop.
    41754177         *
    4176          * @since BuddyPress (1.2.0)
     4178         * @since 1.2.0
    41774179         *
    41784180         * @param string $friend_status Current status of the friendship.
     
    41904192         * Filters whether the member is banned from the current group.
    41914193         *
    4192          * @since BuddyPress (1.0.0)
     4194         * @since 1.0.0
    41934195         *
    41944196         * @param bool $is_banned Whether or not the member is banned.
     
    42054207         * Filters the class to add to the HTML if member is banned.
    42064208         *
    4207          * @since BuddyPress (1.2.6)
     4209         * @since 1.2.6
    42084210         *
    42094211         * @param string $value HTML class to add.
     
    42224224         * Filters the joined since time for the current member in the loop.
    42234225         *
    4224          * @since BuddyPress (1.0.0)
     4226         * @since 1.0.0
    42254227         *
    42264228         * @param string $value Joined since time.
     
    42384240         * Filters the member's user ID for group members loop.
    42394241         *
    4240          * @since BuddyPress (1.0.0)
     4242         * @since 1.0.0
    42414243         *
    42424244         * @param int $user_id User ID of the member.
     
    42634265         * Filters the string to be used as the group pag id.
    42644266         *
    4265          * @since BuddyPress (1.0.0)
     4267         * @since 1.0.0
    42664268         *
    42674269         * @param string $value Value to use for the pag id.
     
    42804282         * Filters the HTML markup to be used for group member listing pagination.
    42814283         *
    4282          * @since BuddyPress (1.0.0)
     4284         * @since 1.0.0
    42834285         *
    42844286         * @param string $pag_links HTML markup for the pagination.
     
    43074309         * Filters the "Viewing x-y of z members" pagination message.
    43084310         *
    4309          * @since BuddyPress (1.0.0)
     4311         * @since 1.0.0
    43104312         *
    43114313         * @param string $value    "Viewing x-y of z members" text.
     
    43304332 * Output the Group members template
    43314333 *
    4332  * @since BuddyPress (2.0.0)
     4334 * @since 2.0.0
    43334335 *
    43344336 * @return string html output
     
    43504352             * Part of bp_groups_members_template_part().
    43514353             *
    4352              * @since BuddyPress (1.5.0)
     4354             * @since 1.5.0
    43534355             */
    43544356            do_action( 'bp_members_directory_member_sub_types' ); ?>
     
    43684370 * Output the Group members filters
    43694371 *
    4370  * @since BuddyPress (2.0.0)
     4372 * @since 2.0.0
    43714373 *
    43724374 * @return string html output
     
    43934395             * Useful for plugins to add more filter options.
    43944396             *
    4395              * @since BuddyPress (2.0.0)
     4397             * @since 2.0.0
    43964398             */
    43974399            do_action( 'bp_groups_members_order_options' ); ?>
     
    44094411 * Determine if the current logged in user can create groups.
    44104412 *
    4411  * @since BuddyPress (1.5.0)
     4413 * @since 1.5.0
    44124414 *
    44134415 * @uses apply_filters() To call 'bp_user_can_create_groups'.
     
    44384440     * Filters if the current logged in user can create groups.
    44394441     *
    4440      * @since BuddyPress (1.5.0)
     4442     * @since 1.5.0
    44414443     *
    44424444     * @param bool $can_create Whether the person can create groups.
     
    44724474     * Fires at the end of the creation of the group tabs.
    44734475     *
    4474      * @since BuddyPress (1.0.0)
     4476     * @since 1.0.0
    44754477     */
    44764478    do_action( 'groups_creation_tabs' );
     
    44834485     * Filters the group creation stage title.
    44844486     *
    4485      * @since BuddyPress (1.1.0)
     4487     * @since 1.1.0
    44864488     *
    44874489     * @param string $value HTML markup for the group creation stage title.
     
    45044506         * Filters the group creation form action.
    45054507         *
    4506          * @since BuddyPress (1.1.0)
     4508         * @since 1.1.0
    45074509         *
    45084510         * @param string $value Action to be used with group creation form.
     
    46034605         * Filters the new group ID.
    46044606         *
    4605          * @since BuddyPress (1.1.0)
     4607         * @since 1.1.0
    46064608         *
    46074609         * @param int $new_group_id ID of the new group.
     
    46224624         * Filters the new group name.
    46234625         *
    4624          * @since BuddyPress (1.1.0)
     4626         * @since 1.1.0
    46254627         *
    46264628         * @param string $name Name of the new group.
     
    46414643         * Filters the new group description.
    46424644         *
    4643          * @since BuddyPress (1.1.0)
     4645         * @since 1.1.0
    46444646         *
    46454647         * @param string $name Description of the new group.
     
    46604662         * Filters whether or not to enable forums for the new group.
    46614663         *
    4662          * @since BuddyPress (1.1.0)
     4664         * @since 1.1.0
    46634665         *
    46644666         * @param int $forum Whether or not to enable forums.
     
    46794681         * Filters the new group status.
    46804682         *
    4681          * @since BuddyPress (1.1.0)
     4683         * @since 1.1.0
    46824684         *
    46834685         * @param string $status Status for the new group.
     
    46894691 * Output the avatar for the group currently being created
    46904692 *
    4691  * @since BuddyPress (1.1.0)
     4693 * @since 1.1.0
    46924694 *
    46934695 * @see bp_core_fetch_avatar() For more information on accepted arguments
     
    47014703     * Return the avatar for the group currently being created
    47024704     *
    4703      * @since BuddyPress (1.1.0)
     4705     * @since 1.1.0
    47044706     *
    47054707     * @see bp_core_fetch_avatar() For a description of arguments and return values.
     
    47444746         * Filters the new group avatar.
    47454747         *
    4746          * @since BuddyPress (1.1.0)
     4748         * @since 1.1.0
    47474749         *
    47484750         * @param string $avatar HTML markup for the new group avatar.
     
    47564758 * Escape & output the URL to the previous group creation step
    47574759 *
    4758  * @since BuddyPress (1.1.0)
     4760 * @since 1.1.0
    47594761 */
    47604762function bp_group_creation_previous_link() {
     
    47644766     * Return the URL to the previous group creation step
    47654767     *
    4766      * @since BuddyPress (1.1.0)
     4768     * @since 1.1.0
    47674769     *
    47684770     * @return string
     
    47934795         * Filters the permalink for the previous step with the group creation process.
    47944796         *
    4795          * @since BuddyPress (1.1.0)
     4797         * @since 1.1.0
    47964798         *
    47974799         * @param string $url Permalink for the previous step.
     
    48034805 * Echoes the current group creation step.
    48044806 *
    4805  * @since BuddyPress (1.6.0)
     4807 * @since 1.6.0
    48064808 */
    48074809function bp_groups_current_create_step() {
     
    48114813     * Returns the current group creation step. If none is found, returns an empty string.
    48124814     *
    4813      * @since BuddyPress (1.6.0)
     4815     * @since 1.6.0
    48144816     *
    48154817     * @uses apply_filters() Filter bp_get_groups_current_create_step to modify.
     
    48314833         * If none is found, returns an empty string.
    48324834         *
    4833          * @since BuddyPress (1.6.0)
     4835         * @since 1.6.0
    48344836         *
    48354837         * @param string $current_create_step Current step in the group creation process.
     
    48414843 * Is the user looking at the last step in the group creation process.
    48424844 *
    4843  * @since BuddyPress (1.1.0)
     4845 * @since 1.1.0
    48444846 *
    48454847 * @param  string $step Step to compare
     
    48644866     * Filters whether or not user is looking at last step in group creation process.
    48654867     *
    4866      * @since BuddyPress (2.4.0)
     4868     * @since 2.4.0
    48674869     *
    48684870     * @param bool   $retval Whether or not we are looking at last step.
     
    48764878 * Is the user looking at the first step in the group creation process
    48774879 *
    4878  * @since BuddyPress (1.1.0)
     4880 * @since 1.1.0
    48794881 *
    48804882 * @param  string $step Step to compare
     
    48994901     * Filters whether or not user is looking at first step in group creation process.
    49004902     *
    4901      * @since BuddyPress (2.4.0)
     4903     * @since 2.4.0
    49024904     *
    49034905     * @param bool   $retval Whether or not we are looking at first step.
     
    49114913 * Output a list of friends who can be invited to a group
    49124914 *
    4913  * @since BuddyPress (1.0.0)
     4915 * @since 1.0.0
    49144916 */
    49154917function bp_new_group_invite_friend_list( $args = array() ) {
     
    49194921     * Return a list of friends who can be invited to a group
    49204922     *
    4921      * @since BuddyPress (1.0.0)
     4923     * @since 1.0.0
    49224924     *
    49234925     * @param  array $args
     
    49664968         * Filters the array of friends who can be invited to a group.
    49674969         *
    4968          * @since BuddyPress (1.0.0)
     4970         * @since 1.0.0
    49694971         *
    49704972         * @param array $items Array of friends.
     
    49995001     * Filters the HTML markup for the groups search form.
    50005002     *
    5001      * @since BuddyPress (1.9.0)
     5003     * @since 1.9.0
    50025004     *
    50035005     * @param string $search_form_html HTML markup for the search form.
     
    50605062 * Is the current page a specific group admin screen?
    50615063 *
    5062  * @since BuddyPress (1.1.0)
     5064 * @since 1.1.0
    50635065 *
    50645066 * @param string $slug
     
    50735075 * Echoes the current group admin tab slug.
    50745076 *
    5075  * @since BuddyPress (1.6.0)
     5077 * @since 1.6.0
    50765078 */
    50775079function bp_group_current_admin_tab() {
     
    50815083     * Returns the current group admin tab slug.
    50825084     *
    5083      * @since BuddyPress (1.6.0)
     5085     * @since 1.6.0
    50845086     *
    50855087     * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value.
     
    50975099         * Filters the current group admin tab slug.
    50985100         *
    5099          * @since BuddyPress (1.6.0)
     5101         * @since 1.6.0
    51005102         *
    51015103         * @param string $tab Current group admin tab slug.
     
    51095111 * Outputs the current group avatar.
    51105112 *
    5111  * @since BuddyPress (1.0.0)
     5113 * @since 1.0.0
    51125114 * @param string $type thumb or full ?
    51135115 * @uses bp_get_group_current_avatar() to get the avatar of the current group.
     
    51195121     * Returns the current group avatar.
    51205122     *
    5121      * @since BuddyPress (2.0.0)
     5123     * @since 2.0.0
    51225124     *
    51235125     * @param string $type thumb or full ?
     
    51385140         * Filters the current group avatar.
    51395141         *
    5140          * @since BuddyPress (2.0.0)
     5142         * @since 2.0.0
    51415143         *
    51425144         * @param string $group_avatar HTML markup for current group avatar.
     
    51485150 * Return whether a group has an avatar.
    51495151 *
    5150  * @since BuddyPress (1.1.0)
     5152 * @since 1.1.0
    51515153 *
    51525154 * @param  int|bool $group_id
     
    51835185         * Filters the URL to delete the group avatar.
    51845186         *
    5185          * @since BuddyPress (1.1.0)
     5187         * @since 1.1.0
    51865188         *
    51875189         * @param string $value URL to delete the group avatar.
     
    53485350             * Fires right before the rewinding of group membership requests list.
    53495351             *
    5350              * @since BuddyPress (1.5.0)
     5352             * @since 1.5.0
    53515353             */
    53525354            do_action( 'group_request_loop_end' );
     
    53695371             * Fires if the current group membership request item is the first in the loop.
    53705372             *
    5371              * @since BuddyPress (1.1.0)
     5373             * @since 1.1.0
    53725374             */
    53735375            do_action( 'group_request_loop_start' );
     
    54045406     * Filters whether or not a group membership query has requests to display.
    54055407     *
    5406      * @since BuddyPress (1.1.0)
     5408     * @since 1.1.0
    54075409     *
    54085410     * @param bool                                   $value             Whether there are requests to display.
     
    54305432     * Filters the requesting user's avatar thumbnail.
    54315433     *
    5432      * @since BuddyPress (1.0.0)
     5434     * @since 1.0.0
    54335435     *
    54345436     * @param string $value HTML markup for the user's avatar thumbnail.
     
    54465448         * Filters the URL to use to reject a membership request.
    54475449         *
    5448          * @since BuddyPress (1.2.6)
     5450         * @since 1.2.6
    54495451         *
    54505452         * @param string $value URL to use to reject a membership request.
     
    54625464         * Filters the URL to use to accept a membership request.
    54635465         *
    5464          * @since BuddyPress (1.2.6)
     5466         * @since 1.2.6
    54655467         *
    54665468         * @param string $value URL to use to accept a membership request.
     
    54785480         * Filters the URL for the user requesting membership.
    54795481         *
    5480          * @since BuddyPress (1.2.6)
     5482         * @since 1.2.6
    54815483         *
    54825484         * @param string $value URL for the user requestion membership.
     
    54915493     * Filters the formatted time since membership was requested.
    54925494     *
    5493      * @since BuddyPress (1.0.0)
     5495     * @since 1.0.0
    54945496     *
    54955497     * @param string $value Formatted time since membership was requested.
     
    55045506     * Filters the membership request comment left by user.
    55055507     *
    5506      * @since BuddyPress (1.0.0)
     5508     * @since 1.0.0
    55075509     *
    55085510     * @param string $value Membership request comment left by user.
     
    55145516 * Output pagination links for group membership requests.
    55155517 *
    5516  * @since BuddyPress (2.0.0)
     5518 * @since 2.0.0
    55175519 */
    55185520function bp_group_requests_pagination_links() {
     
    55225524     * Get pagination links for group membership requests.
    55235525     *
    5524      * @since BuddyPress (2.0.0)
     5526     * @since 2.0.0
    55255527     *
    55265528     * @return string
     
    55325534         * Filters pagination links for group membership requests.
    55335535         *
    5534          * @since BuddyPress (2.0.0)
     5536         * @since 2.0.0
    55355537         *
    55365538         * @param string $value Pagination links for group membership requests.
     
    55425544 * Output pagination count text for group membership requests.
    55435545 *
    5544  * @since BuddyPress (2.0.0)
     5546 * @since 2.0.0
    55455547 */
    55465548function bp_group_requests_pagination_count() {
     
    55505552     * Get pagination count text for group membership requests.
    55515553     *
    5552      * @since BuddyPress (2.0.0)
     5554     * @since 2.0.0
    55535555     *
    55545556     * @return string
     
    55715573         * Filters pagination count text for group membership requests.
    55725574         *
    5573          * @since BuddyPress (2.0.0)
     5575         * @since 2.0.0
    55745576         *
    55755577         * @param string $message  Pagination count text for group membership requests.
     
    56885690             * Fires right before the rewinding of invites list.
    56895691             *
    5690              * @since BuddyPress (1.1.0)
    5691              * @since BuddyPress (2.3.0) `$this` parameter added.
     5692             * @since 1.1.0
     5693             * @since 2.3.0 `$this` parameter added.
    56925694             *
    56935695             * @param BP_Groups_Invite_Template $this Instance of the current Invites template.
     
    57475749             * Fires if the current invite item is the first in the loop.
    57485750             *
    5749              * @since BuddyPress (1.1.0)
    5750              * @since BuddyPress (2.3.0) `$this` parameter added.
     5751             * @since 1.1.0
     5752             * @since 2.3.0 `$this` parameter added.
    57515753             *
    57525754             * @param BP_Groups_Invite_Template $this Instance of the current Invites template.
     
    57895791     * Filters whether or not a group invites query has invites to display.
    57905792     *
    5791      * @since BuddyPress (1.1.0)
     5793     * @since 1.1.0
    57925794     *
    57935795     * @param bool                      $value            Whether there are requests to display.
     
    58185820         * Filters the group invite item ID.
    58195821         *
    5820          * @since BuddyPress (1.1.0)
     5822         * @since 1.1.0
    58215823         *
    58225824         * @param string $value Group invite item ID.
     
    58345836         * Filters the group invite user avatar.
    58355837         *
    5836          * @since BuddyPress (1.1.0)
     5838         * @since 1.1.0
    58375839         *
    58385840         * @param string $value Group invite user avatar.
     
    58505852         * Filters the group invite user link.
    58515853         *
    5852          * @since BuddyPress (1.1.0)
     5854         * @since 1.1.0
    58535855         *
    58545856         * @param string $value Group invite user link.
     
    58665868         * Filters the group invite user's last active time.
    58675869         *
    5868          * @since BuddyPress (1.1.0)
     5870         * @since 1.1.0
    58695871         *
    58705872         * @param string $value Group invite user's last active time.
     
    58935895 * Output pagination links for group invitations.
    58945896 *
    5895  * @since BuddyPress (2.0.0)
     5897 * @since 2.0.0
    58965898 */
    58975899function bp_group_invite_pagination_links() {
     
    59015903     * Get pagination links for group invitations.
    59025904     *
    5903      * @since BuddyPress (2.0.0)
     5905     * @since 2.0.0
    59045906     *
    59055907     * @return string
     
    59115913         * Filters the pagination links for group invitations.
    59125914         *
    5913          * @since BuddyPress (2.0.0)
     5915         * @since 2.0.0
    59145916         *
    59155917         * @param string $value Pagination links for group invitations.
     
    59215923 * Output pagination count text for group invitations.
    59225924 *
    5923  * @since BuddyPress (2.0.0)
     5925 * @since 2.0.0
    59245926 */
    59255927function bp_group_invite_pagination_count() {
     
    59295931     * Get pagination count text for group invitations.
    59305932     *
    5931      * @since BuddyPress (2.0.0)
     5933     * @since 2.0.0
    59325934     *
    59335935     * @return string
     
    59565958 * Hook group activity feed to <head>.
    59575959 *
    5958  * @since BuddyPress (1.5.0)
     5960 * @since 1.5.0
    59595961 */
    59605962function bp_groups_activity_feed() {
     
    59745976 * Output the current group activity-stream RSS URL.
    59755977 *
    5976  * @since BuddyPress (1.5.0)
     5978 * @since 1.5.0
    59775979 */
    59785980function bp_group_activity_feed_link() {
     
    59825984     * Return the current group activity-stream RSS URL.
    59835985     *
    5984      * @since BuddyPress (1.5.0)
     5986     * @since 1.5.0
    59855987     * @return string
    59865988     */
     
    59935995         * Filters the current group activity-stream RSS URL.
    59945996         *
    5995          * @since BuddyPress (1.2.0)
     5997         * @since 1.2.0
    59965998         *
    59975999         * @param string $feed_link Current group activity-stream RSS URL.
     
    60056007 * Echoes the output of bp_get_current_group_id().
    60066008 *
    6007  * @since BuddyPress (1.5.0)
     6009 * @since 1.5.0
    60086010 */
    60096011function bp_current_group_id() {
     
    60136015     * Returns the ID of the current group.
    60146016     *
    6015      * @since BuddyPress (1.5.0)
     6017     * @since 1.5.0
    60166018     * @uses apply_filters() Filter bp_get_current_group_id to modify this output.
    60176019     *
     
    60256027         * Filters the ID of the current group.
    60266028         *
    6027          * @since BuddyPress (1.5.0)
     6029         * @since 1.5.0
    60286030         *
    60296031         * @param int    $current_group_id ID of the current group.
     
    60366038 * Echoes the output of bp_get_current_group_slug().
    60376039 *
    6038  * @since BuddyPress (1.5.0)
     6040 * @since 1.5.0
    60396041 */
    60406042function bp_current_group_slug() {
     
    60446046     * Returns the slug of the current group.
    60456047     *
    6046      * @since BuddyPress (1.5.0)
     6048     * @since 1.5.0
    60476049     * @uses apply_filters() Filter bp_get_current_group_slug to modify this output.
    60486050     *
     
    60566058         * Filters the slug of the current group.
    60576059         *
    6058          * @since BuddyPress (1.5.0)
     6060         * @since 1.5.0
    60596061         *
    60606062         * @param string $current_group_slug Slug of the current group.
     
    60676069 * Echoes the output of bp_get_current_group_name().
    60686070 *
    6069  * @since BuddyPress (1.5.0)
     6071 * @since 1.5.0
    60706072 */
    60716073function bp_current_group_name() {
     
    60756077     * Returns the name of the current group.
    60766078     *
    6077      * @since BuddyPress (1.5.0)
     6079     * @since 1.5.0
    60786080     * @uses apply_filters() Filter bp_get_current_group_name to modify this output.
    60796081     *
     
    60906092         * Filters the name of the current group.
    60916093         *
    6092          * @since BuddyPress (1.2.0)
     6094         * @since 1.2.0
    60936095         *
    60946096         * @param string $name          Name of the current group.
     
    61016103 * Echoes the output of bp_get_current_group_description().
    61026104 *
    6103  * @since BuddyPress (2.1.0)
     6105 * @since 2.1.0
    61046106 */
    61056107function bp_current_group_description() {
     
    61096111     * Returns the description of the current group.
    61106112     *
    6111      * @since BuddyPress (2.1.0)
     6113     * @since 2.1.0
    61126114     * @uses apply_filters() Filter bp_get_current_group_description to modify
    61136115     *                       this output.
     
    61246126         * This filter is used to apply extra filters related to formatting.
    61256127         *
    6126          * @since BuddyPress (1.0.0)
     6128         * @since 1.0.0
    61276129         *
    61286130         * @param string $current_group_desc Description of the current group.
     
    61336135         * Filters the description of the current group.
    61346136         *
    6135          * @since BuddyPress (2.1.0)
     6137         * @since 2.1.0
    61366138         *
    61376139         * @param string $desc Description of the current group.
     
    61436145 * Output a URL for a group component action.
    61446146 *
    6145  * @since BuddyPress (1.2.0)
     6147 * @since 1.2.0
    61466148 *
    61476149 * @param string $action
     
    61576159     * Get a URL for a group component action.
    61586160     *
    6159      * @since BuddyPress (1.2.0)
     6161     * @since 1.2.0
    61606162     *
    61616163     * @param string $action
     
    61996201         * Filters a URL for a group component action.
    62006202         *
    6201          * @since BuddyPress (2.1.0)
     6203         * @since 2.1.0
    62026204         *
    62036205         * @param string $url        URL for a group component action.
     
    62146216 * Display the number of groups in user's profile.
    62156217 *
    6216  * @since BuddyPress (2.0.0)
     6218 * @since 2.0.0
    62176219 *
    62186220 * @param array|string $args before|after|user_id
     
    62286230 * Return the number of groups in user's profile.
    62296231 *
    6230  * @since BuddyPress (2.0.0)
     6232 * @since 2.0.0
    62316233 *
    62326234 * @param array|string $args before|after|user_id
     
    62636265     * Filters the number of groups in user's profile.
    62646266     *
    6265      * @since BuddyPress (2.0.0)
     6267     * @since 2.0.0
    62666268     *
    62676269     * @param string $value HTML for stats output.
  • trunk/src/bp-groups/bp-groups-widgets.php

    r10117 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Widgets
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    4746         * Filters the user ID to use with the widget instance.
    4847         *
    49          * @since BuddyPress (1.5.0)
     48         * @since 1.5.0
    5049         *
    5150         * @param string $value Empty user ID.
     
    6463         * Filters the title of the Groups widget.
    6564         *
    66          * @since BuddyPress (1.8.0)
    67          * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
     65         * @since 1.8.0
     66         * @since 2.3.0 Added 'instance' and 'id_base' to arguments passed to filter.
    6867         *
    6968         * @param string $title    The widget title.
     
    7675         * Filters the separator of the group widget links.
    7776         *
    78          * @since BuddyPress (2.4.0)
     77         * @since 2.4.0
    7978         *
    8079         * @param string $separator Separator string. Default '|'.
  • trunk/src/bp-groups/classes/class-bp-group-extension.php

    r10021 r10148  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    8686 * @package BuddyPress
    8787 * @subpackage Groups
    88  * @since BuddyPress (1.1.0)
     88 * @since 1.1.0
    8989 */
    9090class BP_Group_Extension {
     
    9595     * Information about this extension's screens.
    9696     *
    97      * @since BuddyPress (1.8.0)
     97     * @since 1.8.0
    9898     * @access public
    9999     * @var array
     
    104104     * The name of the extending class.
    105105     *
    106      * @since BuddyPress (1.8.0)
     106     * @since 1.8.0
    107107     * @access public
    108108     * @var string
     
    113113     * A ReflectionClass object of the current extension.
    114114     *
    115      * @since BuddyPress (1.8.0)
     115     * @since 1.8.0
    116116     * @access public
    117117     * @var ReflectionClass
     
    122122     * Parsed configuration parameters for the extension.
    123123     *
    124      * @since BuddyPress (1.8.0)
     124     * @since 1.8.0
    125125     * @access public
    126126     * @var array
     
    131131     * Raw config params, as passed by the extending class.
    132132     *
    133      * @since BuddyPress (2.1.0)
     133     * @since 2.1.0
    134134     * @access public
    135135     * @var array
     
    140140     * The ID of the current group.
    141141     *
    142      * @since BuddyPress (1.8.0)
     142     * @since 1.8.0
    143143     * @access public
    144144     * @var int
     
    189189     * Whether the current user should see the navigation item.
    190190     *
    191      * @since BuddyPress (2.1.0)
     191     * @since 2.1.0
    192192     * @access public
    193193     * @var bool
     
    198198     * Whether the current user can visit the tab.
    199199     *
    200      * @since BuddyPress (2.1.0)
     200     * @since 2.1.0
    201201     * @access public
    202202     * @var bool
     
    237237     * Has the extension been initialized?
    238238     *
    239      * @since BuddyPress (1.8.0)
     239     * @since 1.8.0
    240240     * @access protected
    241241     * @var bool
     
    246246     * Extension properties as set by legacy extensions.
    247247     *
    248      * @since BuddyPress (1.8.0)
     248     * @since 1.8.0
    249249     * @access protected
    250250     * @var array
     
    258258     * then converted to match the new format for params.
    259259     *
    260      * @since BuddyPress (1.8.0)
     260     * @since 1.8.0
    261261     * @access protected
    262262     * @var array
     
    267267     * Redirect location as defined by post-edit save callback.
    268268     *
    269      * @since BuddyPress (2.1.0)
     269     * @since 2.1.0
    270270     * @access protected
    271271     * @var string
     
    276276     * Miscellaneous data as set by the __set() magic method.
    277277     *
    278      * @since BuddyPress (1.8.0)
     278     * @since 1.8.0
    279279     * @access protected
    280280     * @var array
     
    334334     *   }
    335335     *
    336      * @since BuddyPress (1.8.0)
    337      * @since BuddyPress (2.1.0) Added 'access' and 'show_tab' arguments to `$args`.
     336     * @since 1.8.0
     337     * @since 2.1.0 Added 'access' and 'show_tab' arguments to `$args`.
    338338     *
    339339     * @param array $args {
     
    416416     * bp_register_group_extension().
    417417     *
    418      * @since BuddyPress (1.1.0)
     418     * @since 1.1.0
    419419     */
    420420    public function _register() {
     
    463463     * whether your extension overrides certain callback methods.
    464464     *
    465      * @since BuddyPress (1.8.0)
     465     * @since 1.8.0
    466466     */
    467467    protected function setup_class_info() {
     
    483483     *   - group admin
    484484     *
    485      * @since BuddyPress (1.8.0)
     485     * @since 1.8.0
    486486     *
    487487     * @return int
     
    516516     * Gather configuration data about your screens.
    517517     *
    518      * @since BuddyPress (1.8.0)
     518     * @since 1.8.0
    519519     *
    520520     * @return array
     
    551551     * Set up screens array based on params.
    552552     *
    553      * @since BuddyPress (1.8.0)
     553     * @since 1.8.0
    554554     */
    555555    protected function setup_screens() {
     
    570570     * Set up access-related settings for this extension.
    571571     *
    572      * @since BuddyPress (2.1.0)
     572     * @since 2.1.0
    573573     */
    574574    protected function setup_access_settings() {
     
    714714     * Hook this extension's group tab into BuddyPress, if necessary.
    715715     *
    716      * @since BuddyPress (1.8.0)
     716     * @since 1.8.0
    717717     */
    718718    protected function setup_display_hooks() {
     
    784784         * Filters the template to load for the main display method.
    785785         *
    786          * @since BuddyPress (1.0.0)
     786         * @since 1.0.0
    787787         *
    788788         * @param string $template_file Path to the template to load.
     
    797797     * display() callback.
    798798     *
    799      * @since BuddyPress (2.1.1)
     799     * @since 2.1.1
    800800     */
    801801    public function call_display() {
     
    809809     * Access to the tab is controlled by the user_can_visit() check.
    810810     *
    811      * @since BuddyPress (2.1.0)
     811     * @since 2.1.0
    812812     *
    813813     * @param bool $user_can_see_nav_item
     
    826826     * Determine whether the current user has access to visit this tab.
    827827     *
    828      * @since BuddyPress (2.1.0)
     828     * @since 2.1.0
    829829     *
    830830     * @param bool $user_can_visit
     
    847847     * modified before the redirect takes place.
    848848     *
    849      * @since BuddyPress (2.1.0)
     849     * @since 2.1.0
    850850     *
    851851     * @param bool  $user_can_visit
     
    876876     * Hook this extension's Create step into BuddyPress, if necessary.
    877877     *
    878      * @since BuddyPress (1.8.0)
     878     * @since 1.8.0
    879879     */
    880880    protected function setup_create_hooks() {
     
    904904     * Call the create_screen() method, if we're on the right page.
    905905     *
    906      * @since BuddyPress (1.8.0)
     906     * @since 1.8.0
    907907     */
    908908    public function maybe_create_screen() {
     
    922922     * Call the create_screen_save() method, if we're on the right page.
    923923     *
    924      * @since BuddyPress (1.8.0)
     924     * @since 1.8.0
    925925     */
    926926    public function maybe_create_screen_save() {
     
    938938     * Hook this extension's Edit panel into BuddyPress, if necessary.
    939939     *
    940      * @since BuddyPress (1.8.0)
     940     * @since 1.8.0
    941941     */
    942942    protected function setup_edit_hooks() {
     
    10121012     * do not auto-add our own button.
    10131013     *
    1014      * @since BuddyPress (1.8.0)
     1014     * @since 1.8.0
    10151015     */
    10161016    public function call_edit_screen() {
     
    10281028     * Check the nonce, and call the edit_screen_save() method.
    10291029     *
    1030      * @since BuddyPress (1.8.0)
     1030     * @since 1.8.0
    10311031     */
    10321032    public function call_edit_screen_save() {
     
    10611061             * Only runs if a redirect has not already occurred.
    10621062             *
    1063              * @since BuddyPress (2.1.0)
     1063             * @since 2.1.0
    10641064             *
    10651065             * @param string $value URL to redirect to.
     
    10811081     * Hooked to 'bp_screens'.
    10821082     *
    1083      * @since BuddyPress (1.8.0)
     1083     * @since 1.8.0
    10841084     * @access public So that do_action() has access. Do not call directly.
    10851085     *
     
    11001100     * if one is not found.
    11011101     *
    1102      * @since BuddyPress (1.8.0)
     1102     * @since 1.8.0
    11031103     *
    11041104     * @param string $screen The screen markup, captured in the output
     
    11231123     * Does the given markup have a submit button?
    11241124     *
    1125      * @since BuddyPress (1.8.0)
     1125     * @since 1.8.0
    11261126     *
    11271127     * @param string $screen The markup to check.
     
    11381138     * Detect redirects hardcoded into edit_screen_save() callbacks.
    11391139     *
    1140      * @since BuddyPress (2.1.0)
     1140     * @since 2.1.0
    11411141     *
    11421142     * @param string $redirect
     
    11571157     * Hook this extension's Admin metabox into BuddyPress, if necessary.
    11581158     *
    1159      * @since BuddyPress (1.8.0)
     1159     * @since 1.8.0
    11601160     */
    11611161    protected function setup_admin_hooks() {
     
    11771177     * Call the admin_screen() method, and add a nonce field.
    11781178     *
    1179      * @since BuddyPress (1.8.0)
     1179     * @since 1.8.0
    11801180     */
    11811181    public function call_admin_screen() {
     
    11871187     * Check the nonce, and call the admin_screen_save() method.
    11881188     *
    1189      * @since BuddyPress (1.8.0)
     1189     * @since 1.8.0
    11901190     */
    11911191    public function call_admin_screen_save() {
     
    11971197     * Create the Dashboard meta box for this extension.
    11981198     *
    1199      * @since BuddyPress (1.7.0)
     1199     * @since 1.7.0
    12001200     */
    12011201    public function _meta_box_display_callback() {
     
    12251225     * must avoid name clashes.
    12261226     *
    1227      * @since BuddyPress (1.8.0)
     1227     * @since 1.8.0
    12281228     *
    12291229     * @param string $context Screen context. 'create', 'edit', or 'admin'.
     
    12361236     * Check the nonce on a submitted settings form.
    12371237     *
    1238      * @since BuddyPress (1.8.0)
     1238     * @since 1.8.0
    12391239     *
    12401240     * @param string $context Screen context. 'create', 'edit', or 'admin'.
     
    12511251     * must also exist and be callable.
    12521252     *
    1253      * @since BuddyPress (1.8.0)
     1253     * @since 1.8.0
    12541254     *
    12551255     * @param string $context Screen context. 'create', 'edit', or 'admin'.
     
    12991299     * determine whether your extension has provided a given callback.
    13001300     *
    1301      * @since BuddyPress (1.8.0)
     1301     * @since 1.8.0
    13021302     *
    13031303     * @param string $context Screen context. 'create', 'edit', or 'admin'.
     
    13501350     * https://core.trac.wordpress.org/ticket/19888
    13511351     *
    1352      * @since BuddyPress (1.8.0)
     1352     * @since 1.8.0
    13531353     *
    13541354     * @param array $a First set of arguments.
     
    13951395     * self::setup_legacy_properties().
    13961396     *
    1397      * @since BuddyPress (1.8.0)
     1397     * @since 1.8.0
    13981398     *
    13991399     * @param string $key Property name.
     
    14201420     * $this->data array.
    14211421     *
    1422      * @since BuddyPress (1.8.0)
     1422     * @since 1.8.0
    14231423     *
    14241424     * @param string $key Property name.
     
    14441444     * $this->enable_create_step.
    14451445     *
    1446      * @since BuddyPress (1.8.0)
     1446     * @since 1.8.0
    14471447     *
    14481448     * @param string $key Property name.
     
    15091509     * object properties for configuration. Some have been moved.
    15101510     *
    1511      * @since BuddyPress (1.8.0)
     1511     * @since 1.8.0
    15121512     *
    15131513     * @return array List of legacy property keys.
     
    15451545     * parse them into the new init() array.
    15461546     *
    1547      * @since BuddyPress (1.8.0)
     1547     * @since 1.8.0
    15481548     */
    15491549    protected function parse_legacy_properties() {
     
    16261626     * their old locations.
    16271627     *
    1628      * @since BuddyPress (1.8.0)
     1628     * @since 1.8.0
    16291629     *
    16301630     * @see BP_Group_Extension::__get()
  • trunk/src/bp-groups/classes/class-bp-group-member-query.php

    r9906 r10148  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    2323 *   inviter_id = 0 (and invite_sent = 0).
    2424 *
    25  * @since BuddyPress (1.8.0)
     25 * @since 1.8.0
    2626 *
    2727 * @param array $args  {
     
    4545     * Array of group member ids, cached to prevent redundant lookups.
    4646     *
    47      * @since BuddyPress (1.8.1)
     47     * @since 1.8.1
    4848     * @access protected
    4949     * @var null|array Null if not yet defined, otherwise an array of ints.
     
    5454     * Set up action hooks.
    5555     *
    56      * @since BuddyPress (1.8.0)
     56     * @since 1.8.0
    5757     */
    5858    public function setup_hooks() {
     
    7777     * group-member logic.
    7878     *
    79      * @since BuddyPress (1.8.0)
     79     * @since 1.8.0
    8080     *
    8181     * @param array $include Existing group IDs in the $include parameter,
     
    116116     * Get the members of the queried group.
    117117     *
    118      * @since BuddyPress (1.8.0)
     118     * @since 1.8.0
    119119     *
    120120     * @return array $ids User IDs of relevant group member ids.
     
    239239         * defined a custom 'type').
    240240         *
    241          * @since BuddyPress (2.0.0)
     241         * @since 2.0.0
    242242         *
    243243         * @param array                 $group_member_ids Array of associated member IDs.
     
    298298     *      - date_modified
    299299     *
    300      * @since BuddyPress (1.8.0)
     300     * @since 1.8.0
    301301     *
    302302     * @param BP_User_Query $query        BP_User_Query object. Because we're
     
    336336     * Sort user IDs by how recently they have generated activity within a given group.
    337337     *
    338      * @since BuddyPress (2.1.0)
     338     * @since 2.1.0
    339339     *
    340340     * @param BP_User_Query $query  BP_User_Query object.
  • trunk/src/bp-groups/classes/class-bp-groups-group.php

    r9982 r10148  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    108108     * Is the current user a member of this group?
    109109     *
    110      * @since BuddyPress (1.2.0)
     110     * @since 1.2.0
    111111     * @var bool
    112112     */
     
    116116     * Does the current user have an outstanding invitation to this group?
    117117     *
    118      * @since BuddyPress (1.9.0)
     118     * @since 1.9.0
    119119     * @var bool
    120120     */
     
    124124     * Does the current user have a pending membership request to this group?
    125125     *
    126      * @since BuddyPress (1.9.0)
     126     * @since 1.9.0
    127127     * @var bool
    128128     */
     
    132132     * Timestamp of the last activity that happened in this group.
    133133     *
    134      * @since BuddyPress (1.2.0)
     134     * @since 1.2.0
    135135     * @var string
    136136     */
     
    140140     * If this is a private or hidden group, does the current user have access?
    141141     *
    142      * @since BuddyPress (1.6.0)
     142     * @since 1.6.0
    143143     * @var bool
    144144     */
     
    148148     * Raw arguments passed to the constructor.
    149149     *
    150      * @since BuddyPress (2.0.0)
     150     * @since 2.0.0
    151151     * @var array
    152152     */
     
    217217             * Filters the SQL prepared statement used to fetch group admins and mods.
    218218             *
    219              * @since BuddyPress (1.5.0)
     219             * @since 1.5.0
    220220             *
    221221             * @param string $value SQL select statement used to fetch admins and mods.
     
    282282         * Please use this hook to filter the properties above. Each part will be passed in.
    283283         *
    284          * @since BuddyPress (1.0.0)
     284         * @since 1.0.0
    285285         *
    286286         * @param BP_Groups_Group $this Current instance of the group item being saved. Passed by reference.
     
    362362         * Fires after the current group item has been saved.
    363363         *
    364          * @since BuddyPress (1.0.0)
     364         * @since 1.0.0
    365365         *
    366366         * @param BP_Groups_Group $this Current instance of the group item that was saved. Passed by reference.
     
    397397         * Fires before the deletion of a group.
    398398         *
    399          * @since BuddyPress (1.2.0)
     399         * @since 1.2.0
    400400         *
    401401         * @param BP_Groups_Group $this     Current instance of the group item being deleted. Passed by reference.