Skip to:
Content

BuddyPress.org

Changeset 9512


Ignore:
Timestamp:
02/18/2015 05:05:55 AM (10 years ago)
Author:
tw2113
Message:

Adds hooks documentation to bp-groups-template.php.

See #5943.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r9471 r9512  
    2424     */
    2525    function bp_get_groups_slug() {
     26
     27        /**
     28         * Filters the groups component slug.
     29         *
     30         * @since BuddyPress (1.5.0)
     31         *
     32         * @param string $slug Groups component slug.
     33         */
    2634        return apply_filters( 'bp_get_groups_slug', buddypress()->groups->slug );
    2735    }
    … …  
    3644}
    3745    /**
    38      * Return the groups component root slug
     46     * Return the groups component root slug.
    3947     *
    4048     * @since BuddyPress (1.5.0)
    … …  
    4351     */
    4452    function bp_get_groups_root_slug() {
     53
     54        /**
     55         * Filters the groups component root slug.
     56         *
     57         * @since BuddyPress (1.5.0)
     58         *
     59         * @param string $root_slug Groups component root slug.
     60         */
    4561        return apply_filters( 'bp_get_groups_root_slug', buddypress()->groups->root_slug );
    4662    }
    … …  
    6278     */
    6379    function bp_get_groups_directory_permalink() {
     80
     81        /**
     82         * Filters the group directory permalink.
     83         *
     84         * @since BuddyPress (1.5.0)
     85         *
     86         * @param string $value Permalink for the group directory.
     87         */
    6488        return apply_filters( 'bp_get_groups_directory_permalink', trailingslashit( bp_get_root_domain() . '/' . bp_get_groups_root_slug() ) );
    6589    }
    … …  
    397421            return true;
    398422        } elseif ( $this->current_group + 1 == $this->group_count ) {
     423
     424            /**
     425             * Fires right before the rewinding of groups list.
     426             *
     427             * @since BuddyPress (1.5.0)
     428             */
    399429            do_action('group_loop_end');
    400430            // Do some cleaning up after the loop
    … …  
    419449        $this->group       = $this->next_group();
    420450
    421         if ( 0 == $this->current_group ) // loop has just started
    422             do_action('group_loop_start');
     451        if ( 0 == $this->current_group ) {
     452
     453            /**
     454             * Fires if the current group item is the first in the loop.
     455             *
     456             * @since BuddyPress (1.1.0)
     457             */
     458            do_action( 'group_loop_start' );
     459        }
    423460    }
    424461}
    … …  
    542579    ) );
    543580
    544     // Filter and return whether or not the groups loop has groups in it
     581    /**
     582     * Filters whether or not there are groups to iterate over for the groups loop.
     583     *
     584     * @since BuddyPress (1.1.0)
     585     *
     586     * @param bool               $value           Whether or not there are groups to iterate over.
     587     * @param BP_Groups_Template $groups_template BP_Groups_Template object based on parsed arguments.
     588     * @param array              $r               Array of parsed arguments for the query.
     589     */
    545590    return apply_filters( 'bp_has_groups', $groups_template->has_groups(), $groups_template, $r );
    546591}
    … …  
    613658            $group =& $groups_template->group;
    614659
     660        /**
     661         * Filters the ID of the current group in the loop.
     662         *
     663         * @since BuddyPress (1.0.0)
     664         *
     665         * @param int $id ID of the current group in the loop.
     666         */
    615667        return apply_filters( 'bp_get_group_id', $group->id );
    616668    }
    … …  
    658710        }
    659711
     712        /**
     713         * Filters classes that will be applied to row class of the current group in the loop.
     714         *
     715         * @since BuddyPress (1.7.0)
     716         *
     717         * @param array $classes Array of determined classes for the row.
     718         */
    660719        $classes = apply_filters( 'bp_get_group_class', $classes );
    661720        $classes = array_merge( $classes, array() );
    … …  
    687746            $group =& $groups_template->group;
    688747
     748        /**
     749         * Filters the name of the current group in the loop.
     750         *
     751         * @since BuddyPress (1.0.0)
     752         *
     753         * @param string $name Name of the current group in the loop.
     754         */
    689755        return apply_filters( 'bp_get_group_name', $group->name );
    690756    }
    … …  
    722788        }
    723789
     790        /**
     791         * Filters the type for the current group in the loop.
     792         *
     793         * @since BuddyPress (1.0.0)
     794         *
     795         * @param string $type Type for the current group in the loop.
     796         */
    724797        return apply_filters( 'bp_get_group_type', $type );
    725798    }
    … …  
    747820            $group =& $groups_template->group;
    748821
     822        /**
     823         * Filters the status of the current group in the loop.
     824         *
     825         * @since BuddyPress (1.0.0)
     826         *
     827         * @param string $status Status of the current group in the loop.
     828         */
    749829        return apply_filters( 'bp_get_group_status', $group->status );
    750830    }
    … …  
    814894        }
    815895
     896        /**
     897         * Filters the group avatar while in the groups loop.
     898         *
     899         * @since BuddyPress (1.0.0)
     900         *
     901         * @param string $avatar HTML image element holding the group avatar.
     902         * @param array  $r      Array of parsed arguments for the group avatar.
     903         */
    816904        return apply_filters( 'bp_get_group_avatar', $avatar, $r );
    817905    }
    … …  
    902990            return __( 'not yet active', 'buddypress' );
    903991        } else {
     992
     993            /**
     994             * Filters the 'last active' string for the current gorup in the loop.
     995             *
     996             * @since BuddyPress (1.0.0)
     997             *
     998             * @param string $value Determined last active value for the current group.
     999             */
    9041000            return apply_filters( 'bp_get_group_last_active', bp_core_time_since( $last_active ) );
    9051001        }
    … …  
    9291025        }
    9301026
     1027        /**
     1028         * Filters the permalink for the current group in the loop.
     1029         *
     1030         * @since BuddyPress (1.0.0)
     1031         *
     1032         * @param string $value Permalink for the current group in the loop.
     1033         */
    9311034        return apply_filters( 'bp_get_group_permalink', trailingslashit( bp_get_groups_directory_permalink() . $group->slug . '/' ) );
    9321035    }
    … …  
    9541057            $group =& $groups_template->group;
    9551058
     1059        /**
     1060         * Filters the permalink for the admin section of the current group in the loop.
     1061         *
     1062         * @since BuddyPress (1.0.0)
     1063         *
     1064         * @param string $value Permalink for the admin section of the current group in the loop.
     1065         */
    9561066        return apply_filters( 'bp_get_group_admin_permalink', trailingslashit( bp_get_group_permalink( $group ) . 'admin' ) );
    9571067    }
    … …  
    9791089            $group =& $groups_template->group;
    9801090
     1091        /**
     1092         * Filters the slug for the current group in the loop.
     1093         *
     1094         * @since BuddyPress (1.0.0)
     1095         *
     1096         * @param string $slug Slug for the current group in the loop.
     1097         */
    9811098        return apply_filters( 'bp_get_group_slug', $group->slug );
    9821099    }
    … …  
    10041121            $group =& $groups_template->group;
    10051122
     1123        /**
     1124         * Filters the description for the current group in the loop.
     1125         *
     1126         * @since BuddyPress (1.0.0)
     1127         *
     1128         * @param string $value Description for the current group.
     1129         */
    10061130        return apply_filters( 'bp_get_group_description', stripslashes($group->description) );
    10071131    }
    … …  
    10331157            $group =& $groups_template->group;
    10341158
     1159        /**
     1160         * Filters the permalink for the current group in the loop, for use in a textarea.
     1161         *
     1162         * 'bp_get_group_description_editable' does not have the formatting
     1163         * filters that 'bp_get_group_description' has, which makes it
     1164         * appropriate for "raw" editing.
     1165         *
     1166         * @since BuddyPress (1.0.0)
     1167         *
     1168         * @param string $description Description for the current group in the loop.
     1169         */
    10351170        return apply_filters( 'bp_get_group_description_editable', $group->description );
    10361171    }
    … …  
    10591194        }
    10601195
     1196        /**
     1197         * Filters the excerpt of a group description.
     1198         *
     1199         * @since BuddyPress (1.0.0)
     1200         *
     1201         * @param string $value Excerpt of a group description.
     1202         * @param object $group Object for group whose description is made into an excerpt.
     1203         */
    10611204        return apply_filters( 'bp_get_group_description_excerpt', bp_create_excerpt( $group->description ), $group );
    10621205    }
    … …  
    11461289            $group =& $groups_template->group;
    11471290
     1291        /**
     1292         * Filters the created date of the current group in the loop.
     1293         *
     1294         * @since BuddyPress (1.0.0)
     1295         *
     1296         * @param string $value Created date for the current group.
     1297         */
    11481298        return apply_filters( 'bp_get_group_date_created', bp_core_time_since( strtotime( $group->date_created ) ) );
    11491299    }
    … …  
    11711321            $group =& $groups_template->group;
    11721322
     1323        /**
     1324         * Filters the username of the creator of the current group in the loop.
     1325         *
     1326         * @since BuddyPress (1.7.0)
     1327         *
     1328         * @param string $value Username of the group creator.
     1329         */
    11731330        return apply_filters( 'bp_get_group_creator_username', bp_core_get_user_displayname( $group->creator_id ) );
    11741331    }
    … …  
    11961353            $group =& $groups_template->group;
    11971354
     1355        /**
     1356         * Filters the user ID of the creator of the current group in the loop.
     1357         *
     1358         * @since BuddyPress (1.7.0)
     1359         *
     1360         * @param int $creator_id User ID of the group creator.
     1361         */
    11981362        return apply_filters( 'bp_get_group_creator_id', $group->creator_id );
    11991363    }
    … …  
    12211385            $group =& $groups_template->group;
    12221386
     1387        /**
     1388         * Filters the permalink of the creator of the current group in the loop.
     1389         *
     1390         * @since BuddyPress (1.7.0)
     1391         *
     1392         * @param string $value Permalink of the group creator.
     1393         */
    12231394        return apply_filters( 'bp_get_group_creator_permalink', bp_core_get_user_domain( $group->creator_id ) );
    12241395    }
    … …  
    12951466        $avatar = bp_core_fetch_avatar( array( 'item_id' => $group->creator_id, 'type' => $type, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'alt' => $alt ) );
    12961467
     1468        /**
     1469         * Filters the avatar of the creator of the current group in the loop.
     1470         *
     1471         * @since BuddyPress (1.7.0)
     1472         *
     1473         * @param string $avatar Avatar of the group creator.
     1474         */
    12971475        return apply_filters( 'bp_get_group_creator_avatar', $avatar );
    12981476    }
    … …  
    14361614        $admin_ids = implode( ',', $admin_ids );
    14371615
     1616    /**
     1617     * Filters a list of user IDs for a group's admins.
     1618     *
     1619     * This filter may return either an array or a comma separated string.
     1620     *
     1621     * @since BuddyPress (1.5.0)
     1622     *
     1623     * @param array|string $admin_ids List of user IDs for a group's admins.
     1624     */
    14381625    return apply_filters( 'bp_group_admin_ids', $admin_ids );
    14391626}
    … …  
    14671654        $mod_ids = implode( ',', $mod_ids );
    14681655
     1656    /**
     1657     * Filters a list of user IDs for a group's moderators.
     1658     *
     1659     * This filter may return either an array or a comma separated string.
     1660     *
     1661     * @since BuddyPress (1.5.0)
     1662     *
     1663     * @param array|string $admin_ids List of user IDs for a group's moderators.
     1664     */
    14691665    return apply_filters( 'bp_group_mod_ids', $mod_ids );
    14701666}
    … …  
    14891685            $group =& $groups_template->group;
    14901686
     1687        /**
     1688         * Filters the permalink of the Members page for the current group in the loop.
     1689         *
     1690         * @since BuddyPress (1.0.0)
     1691         *
     1692         * @param string $value Permalink of the Members page for the current group.
     1693         */
    14911694        return apply_filters( 'bp_get_group_all_members_permalink', bp_get_group_permalink( $group ) . 'members' );
    14921695    }
    … …  
    15621765        global $groups_template;
    15631766
     1767        /**
     1768         * Filters the pagination HTML for a group loop.
     1769         *
     1770         * @since BuddyPress (1.2.0)
     1771         *
     1772         * @param string $pag_links HTML markup for the pagination links.
     1773         */
    15641774        return apply_filters( 'bp_get_groups_pagination_links', $groups_template->pag_links );
    15651775    }
    … …  
    15841794        $total     = bp_core_number_format( $groups_template->total_group_count );
    15851795
     1796        /**
     1797         * Filters the "Viewing x-y of z groups" pagination message.
     1798         *
     1799         * @since BuddyPress (1.5.0)
     1800         *
     1801         * @param string $value    "Viewing x-y of z groups" text.
     1802         * @param string $from_num Total amount for the low value in the range.
     1803         * @param string $to_num   Total amount for the high value in the range.
     1804         * @param string $total    Total amount of groups found.
     1805         */
    15861806        return apply_filters( 'bp_get_groups_pagination_count', sprintf( _n( 'Viewing 1 group', 'Viewing %1$s - %2$s of %3$s groups', $total, 'buddypress' ), $from_num, $to_num, $total ), $from_num, $to_num, $total );
    15871807    }
    … …  
    15961816 */
    15971817function bp_groups_auto_join() {
     1818
     1819    /**
     1820     * Filters whether groups auto-join is enabled.
     1821     *
     1822     * @since BuddyPres (1.2.6)
     1823     *
     1824     * @param bool $value Enabled status.
     1825     */
    15981826    return apply_filters( 'bp_groups_auto_join', (bool) buddypress()->groups->auto_join );
    15991827}
    … …  
    16191847            $group =& $groups_template->group;
    16201848
     1849        /**
     1850         * Filters the total member count for a group.
     1851         *
     1852         * @since BuddyPress (1.0.0)
     1853         *
     1854         * @param int $total_member_count Total member count for a group.
     1855         */
    16211856        return apply_filters( 'bp_get_group_total_members', $group->total_member_count );
    16221857    }
    … …  
    16471882        $count_string = sprintf( _n( '%s member', '%s members', $count, 'buddypress' ), bp_core_number_format( $count ) );
    16481883
     1884        /**
     1885         * Filters the "x members" count string for a group.
     1886         *
     1887         * @since BuddyPress (1.2.0)
     1888         *
     1889         * @param string $count_string The "x members" count string for a group.
     1890         */
    16491891        return apply_filters( 'bp_get_group_member_count', $count_string );
    16501892    }
    … …  
    16681910            $group =& $groups_template->group;
    16691911
     1912        /**
     1913         * Filters the URL of the Forum page of a group.
     1914         *
     1915         * @since BuddyPress (1.0.0)
     1916         *
     1917         * @param string $value URL permalink for the Forum Page.
     1918         */
    16701919        return apply_filters( 'bp_get_group_forum_permalink', bp_get_group_permalink( $group ) . 'forum' );
    16711920    }
    … …  
    17181967        }
    17191968
     1969        /**
     1970         * Filters the topic count string for a group forum.
     1971         *
     1972         * @since BuddyPress (1.2.0)
     1973         *
     1974         * @param string $total_topics Total topic count string.
     1975         * @param bool   $showtext     Whether or not to return as formatted string.
     1976         */
    17201977        return apply_filters( 'bp_get_group_forum_topic_count', $total_topics, (bool)$showtext );
    17211978    }
    … …  
    17682025        }
    17692026
     2027        /**
     2028         * Filters the post count string for a group forum.
     2029         *
     2030         * @since BuddyPress (1.2.0)
     2031         *
     2032         * @param string $total_posts Total post count string.
     2033         * @param bool   $showtext    Whether or not to return as formatted string.
     2034         */
    17702035        return apply_filters( 'bp_get_group_forum_post_count', $total_posts, (bool)$showtext );
    17712036    }
    … …  
    18812146    }
    18822147
     2148    /**
     2149     * Filters the invite status of a group.
     2150     *
     2151     * Invite status in this case means who from the group can send invites.
     2152     *
     2153     * @since BuddyPress (1.5.0)
     2154     *
     2155     * @param string $invite_status Membership level needed to send an invite.
     2156     * @param int    $group_id      ID of the group whose status is being checked.
     2157     */
    18832158    return apply_filters( 'bp_group_get_invite_status', $invite_status, $group_id );
    18842159}
    … …  
    21092384        $group =& $groups_template->group;
    21102385
     2386    /**
     2387     * Filters whether a group has moderators.
     2388     *
     2389     * @since BuddyPress (1.0.0)
     2390     *
     2391     * @param array $value Array of user IDs who are a moderator of the provided group.
     2392     */
    21112393    return apply_filters( 'bp_group_has_moderators', groups_get_group_mods( $group->id ) );
    21122394}
    … …  
    21412423        extract( $r, EXTR_SKIP );
    21422424
     2425        /**
     2426         * Filters a URL for promoting a user to moderator.
     2427         *
     2428         * @since BuddyPress (1.1.0)
     2429         *
     2430         * @param string $value URL to use for promoting a user to moderator.
     2431         */
    21432432        return apply_filters( 'bp_get_group_member_promote_mod_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/promote/mod/' . $user_id, 'groups_promote_member' ) );
    21442433    }
    … …  
    21732462        extract( $r, EXTR_SKIP );
    21742463
     2464        /**
     2465         * Filters a URL for promoting a user to admin.
     2466         *
     2467         * @since BuddyPress (1.1.0)
     2468         *
     2469         * @param string $value URL to use for promoting a user to admin.
     2470         */
    21752471        return apply_filters( 'bp_get_group_member_promote_admin_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/promote/admin/' . $user_id, 'groups_promote_member' ) );
    21762472    }
    … …  
    22072503            $user_id = $members_template->member->user_id;
    22082504
     2505        /**
     2506         * Filters a URL for demoting a user to member.
     2507         *
     2508         * @since BuddyPress (1.0.0)
     2509         *
     2510         * @param string $value URL to use for demoting a user to member.
     2511         */
    22092512        return apply_filters( 'bp_get_group_member_demote_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/demote/' . $user_id, 'groups_demote_member' ) );
    22102513    }
    … …  
    22382541            $group =& $groups_template->group;
    22392542
     2543        /**
     2544         * Filters a URL for banning a member from a group.
     2545         *
     2546         * @since BuddyPress (1.0.0)
     2547         *
     2548         * @param string $value URL to use for banning a member.
     2549         */
    22402550        return apply_filters( 'bp_get_group_member_ban_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/ban/' . $user_id, 'groups_ban_member' ) );
    22412551    }
    … …  
    22722582            $group =& $groups_template->group;
    22732583
     2584        /**
     2585         * Filters a URL for unbanning a member from a group.
     2586         *
     2587         * @since BuddyPress (1.0.0)
     2588         *
     2589         * @param string $value URL to use for unbanning a member.
     2590         */
    22742591        return apply_filters( 'bp_get_group_member_unban_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/unban/' . $user_id, 'groups_unban_member' ) );
    22752592    }
    … …  
    23032620            $group =& $groups_template->group;
    23042621
     2622        /**
     2623         * Filters a URL for removing a member from a group.
     2624         *
     2625         * @since BuddyPress (1.2.6)
     2626         *
     2627         * @param string $value URL to use for removing a member.
     2628         */
    23052629        return apply_filters( 'bp_get_group_member_remove_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'admin/manage-members/remove/' . $user_id, 'groups_remove_member' ) );
    23062630    }
    … …  
    23752699     */
    23762700    function bp_get_group_total_for_member() {
     2701
     2702        /**
     2703         * FIlters the group count for a displayed user.
     2704         *
     2705         * @since BuddyPress (1.1.0)
     2706         *
     2707         * @param int $value Total group count for a displayed user.
     2708         */
    23772709        return apply_filters( 'bp_get_group_total_for_member', BP_Groups_Member::total_group_count() );
    23782710    }
    … …  
    24002732            $group =& $groups_template->group;
    24012733
     2734        /**
     2735         * Filters the 'action' attribute for a group form.
     2736         *
     2737         * @since BuddyPress (1.0.0)
     2738         *
     2739         * @param string $value Action attribute for a group form.
     2740         */
    24022741        return apply_filters( 'bp_group_form_action', bp_get_group_permalink( $group ) . $page );
    24032742    }
    … …  
    24282767            $page = bp_action_variable( 0 );
    24292768
     2769        /**
     2770         * Filters the 'action' attribute for a group admin form.
     2771         *
     2772         * @since BuddyPress (1.0.0)
     2773         *
     2774         * @param string $value Action attribute for a group admin form.
     2775         */
    24302776        return apply_filters( 'bp_group_admin_form_action', bp_get_group_permalink( $group ) . 'admin/' . $page );
    24312777    }
    … …  
    24692815        $group =& $groups_template->group;
    24702816
     2817    /**
     2818     * Filters whether current user is member of a group.
     2819     *
     2820     * @since BuddyPress (1.2.4)
     2821     *
     2822     * @param bool $is_member If user is a member of group or not.
     2823     */
    24712824    return apply_filters( 'bp_group_is_member', !empty( $group->is_member ) );
    24722825}
    … …  
    24862839    }
    24872840
     2841    /**
     2842     * Filters whether current user has an outstanding invite to current group in loop.
     2843     *
     2844     * @since BuddyPress (2.1.0)
     2845     *
     2846     * @param bool $is_invited If user has an outstanding group invite.
     2847     */
    24882848    return apply_filters( 'bp_group_is_invited', ! empty( $group->is_invited ) );
    24892849}
    … …  
    25402900    }
    25412901
     2902    /**
     2903     * Filters whether current user has been banned from current group in loop.
     2904     *
     2905     * @since BuddyPress (1.5.0)
     2906     *
     2907     * @param bool $is_invited If user has been from current group.
     2908     */
    25422909    return (bool) apply_filters( 'bp_group_is_user_banned', $retval );
    25432910}
    … …  
    25642931        $bp = buddypress();
    25652932
     2933        /**
     2934         * Filters the URL for accepting an invitation to a group.
     2935         *
     2936         * @since BuddyPress (1.0.0)
     2937         *
     2938         * @param string $value URL for accepting an invitation to a group.
     2939         */
    25662940        return apply_filters( 'bp_get_group_accept_invite_link', wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() . '/invites/accept/' . $group->id ), 'groups_accept_invite' ) );
    25672941    }
    … …  
    25882962        $bp = buddypress();
    25892963
     2964        /**
     2965         * Filters the URL for rejecting an invitation to a group.
     2966         *
     2967         * @since BuddyPress (1.0.0)
     2968         *
     2969         * @param string $value URL for rejecting an invitation to a group.
     2970         */
    25902971        return apply_filters( 'bp_get_group_reject_invite_link', wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_groups_slug() . '/invites/reject/' . $group->id ), 'groups_reject_invite' ) );
    25912972    }
    … …  
    26102991            $group =& $groups_template->group;
    26112992
     2993        /**
     2994         * Filters the URL for confirming a request to leave a group.
     2995         *
     2996         * @since BuddyPress (1.0.0)
     2997         *
     2998         * @param string $value URL for confirming a request to leave a group.
     2999         */
    26123000        return apply_filters( 'bp_group_leave_confirm_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'leave-group/yes', 'groups_leave_group' ) );
    26133001    }
    … …  
    26323020            $group =& $groups_template->group;
    26333021
     3022        /**
     3023         * Filters the URL for rejecting a request to leave a group.
     3024         *
     3025         * @since BuddyPress (1.0.0)
     3026         *
     3027         * @param string $value URL for rejecting a request to leave a group.
     3028         */
    26343029        return apply_filters( 'bp_get_group_leave_reject_link', bp_get_group_permalink( $group ) );
    26353030    }
    … …  
    26543049            $group =& $groups_template->group;
    26553050
     3051        /**
     3052         * Filters the 'action' attribute for a group send invite form.
     3053         *
     3054         * @since BuddyPress (1.0.0)
     3055         *
     3056         * @param string $value Action attribute for a group send invite form.
     3057         */
    26563058        return apply_filters( 'bp_group_send_invite_form_action', bp_get_group_permalink( $group ) . 'send-invites/send' );
    26573059    }
    … …  
    27213123        );
    27223124
    2723         // Filter and return the HTML button
     3125        /**
     3126         * Filters the HTML button for creating a new topic in a group.
     3127         *
     3128         * @since BuddyPress (1.5.0)
     3129         *
     3130         * @param string $button HTML button for a new topic.
     3131         */
    27243132        return bp_get_button( apply_filters( 'bp_get_group_new_topic_button', $button ) );
    27253133    }
    … …  
    28613269        }
    28623270
    2863         // Filter and return the HTML button
     3271        /**
     3272         * Filters the HTML button for joining a group.
     3273         *
     3274         * @since BuddyPress (1.2.6)
     3275         *
     3276         * @param string $button HTML button for joining a group.
     3277         */
    28643278        return bp_get_button( apply_filters( 'bp_get_group_join_button', $button ) );
    28653279    }
    … …  
    29003314        );
    29013315
     3316        /**
     3317         * Filters the HTML button for creating a group.
     3318         *
     3319         * @since BuddyPress (2.0.0)
     3320         *
     3321         * @param string $button HTML button for creating a group.
     3322         */
    29023323        return bp_get_button( apply_filters( 'bp_get_group_create_button', $button_args ) );
    29033324    }
    … …  
    29303351        $output = '<li id="group-create-nav">' . $create_group_button . '</li>';
    29313352
     3353        /**
     3354         * Filters the Create a Group nav item.
     3355         *
     3356         * @since BuddyPress (2.2.0)
     3357         *
     3358         * @param string $output HTML output for nav item.
     3359         */
    29323360        return apply_filters( 'bp_get_group_create_nav_item', $output );
    29333361    }
    … …  
    30053433    }
    30063434
     3435    /**
     3436     * Filters a message if the group is not visible to the current user.
     3437     *
     3438     * This will be true if it is a hidden or private group, and the user does not have access.
     3439     *
     3440     * @since BuddyPress (1.6.0)
     3441     *
     3442     * @param string $message Message to display to the current user.
     3443     * @param object $group   Group to get status message for.
     3444     */
    30073445    echo apply_filters( 'bp_group_status_message', $message, $group );
    30083446}
    … …  
    30443482     */
    30453483    function bp_get_total_group_count() {
     3484
     3485        /**
     3486         * Filters the total number of groups.
     3487         *
     3488         * @since BuddyPress (1.0.0)
     3489         *
     3490         * @param int $value Total number of groups found.
     3491         */
    30463492        return apply_filters( 'bp_get_total_group_count', groups_get_total_group_count() );
    30473493    }
    … …  
    30693515        $count = groups_total_groups_for_user( $user_id );
    30703516
     3517        /**
     3518         * Filters the total number of groups a user belongs to.
     3519         *
     3520         * @since BuddyPress (1.2.0)
     3521         *
     3522         * @param int $count   Total number of groups for the user.
     3523         * @param int $user_id ID of the user being checked.
     3524         */
    30713525        return apply_filters( 'bp_get_total_group_count_for_user', $count, $user_id );
    30723526    }
    … …  
    32223676            return true;
    32233677        } elseif ( $tick == $this->member_count ) {
     3678
    32243679            do_action( 'loop_end' );
    32253680            // Do some cleaning up after the loop
    … …  
    32943749
    32953750    $members_template = new BP_Groups_Group_Members_Template( $r );
     3751
     3752    /**
     3753     * Filters whether or not a group member query has members to display.
     3754     *
     3755     * @since BuddyPress (1.1.0)
     3756     *
     3757     * @param bool                             $value            Whether there are members to display.
     3758     * @param BP_Groups_Group_Members_Template $members_template Object holding the member query results.
     3759     */
    32963760    return apply_filters( 'bp_group_has_members', $members_template->has_members(), $members_template );
    32973761}
    … …  
    33363800        ) );
    33373801
     3802        /**
     3803         * Filters the group member avatar while in the groups members loop.
     3804         *
     3805         * @since BuddyPress (1.0.0)
     3806         *
     3807         * @param string $value HTML markup for group member avatar.
     3808         * @param array  $r     Parsed args used for the avatar query.
     3809         */
    33383810        return apply_filters( 'bp_get_group_member_avatar', bp_core_fetch_avatar( $r ), $r );
    33393811    }
    … …  
    33673839        ) );
    33683840
     3841        /**
     3842         * Filters the group member avatar thumb while in the groups members loop.
     3843         *
     3844         * @since BuddyPress (1.1.0)
     3845         *
     3846         * @param string $value HTML markup for group member avatar thumb.
     3847         * @param array  $r     Parsed args used for the avatar query.
     3848         */
    33693849        return apply_filters( 'bp_get_group_member_avatar_thumb', bp_core_fetch_avatar( $r ), $r );
    33703850    }
    … …  
    33993879        ) );
    34003880
     3881        /**
     3882         * Filters the group member avatar mini while in the groups members loop.
     3883         *
     3884         * @since BuddyPress (1.0.0)
     3885         *
     3886         * @param string $value HTML markup for group member avatar mini.
     3887         * @param array  $r     Parsed args used for the avatar query.
     3888         */
    34013889        return apply_filters( 'bp_get_group_member_avatar_mini', bp_core_fetch_avatar( $r ), $r );
    34023890    }
    … …  
    34083896        global $members_template;
    34093897
     3898        /**
     3899         * Filters the group member display name of the current user in the loop.
     3900         *
     3901         * @since BuddyPress (1.0.0)
     3902         *
     3903         * @param string $display_name Display name of the current user.
     3904         */
    34103905        return apply_filters( 'bp_get_group_member_name', $members_template->member->display_name );
    34113906    }
    … …  
    34173912        global $members_template;
    34183913
     3914        /**
     3915         * Filters the group member url for the current user in the loop.
     3916         *
     3917         * @since BuddyPress (1.0.0)
     3918         *
     3919         * @param string $value URL for the current user.
     3920         */
    34193921        return apply_filters( 'bp_get_group_member_url', bp_core_get_user_domain( $members_template->member->user_id, $members_template->member->user_nicename, $members_template->member->user_login ) );
    34203922    }
    … …  
    34263928        global $members_template;
    34273929
     3930        /**
     3931         * Filters the group member HTML link for the current user in the loop.
     3932         *
     3933         * @since BuddyPress (1.0.0)
     3934         *
     3935         * @param string $value HTML link for the current user.
     3936         */
    34283937        return apply_filters( 'bp_get_group_member_link', '<a href="' . bp_core_get_user_domain( $members_template->member->user_id, $members_template->member->user_nicename, $members_template->member->user_login ) . '">' . $members_template->member->display_name . '</a>' );
    34293938    }
    … …  
    34353944        global $members_template;
    34363945
     3946        /**
     3947         * Filters the group member domain for the current user in the loop.
     3948         *
     3949         * @since BuddyPress (1.2.0)
     3950         *
     3951         * @param string $value Domain for the current user.
     3952         */
    34373953        return apply_filters( 'bp_get_group_member_domain', bp_core_get_user_domain( $members_template->member->user_id, $members_template->member->user_nicename, $members_template->member->user_login ) );
    34383954    }
    … …  
    34493965            $friend_status = ( 0 == $members_template->member->is_friend ) ? 'pending' : 'is_friend';
    34503966
     3967        /**
     3968         * Filters the friendship status between current user and displayed user in group member loop.
     3969         *
     3970         * @since BuddyPress (1.2.0)
     3971         *
     3972         * @param string $friend_status Current status of the friendship.
     3973         */
    34513974        return apply_filters( 'bp_get_group_member_is_friend', $friend_status );
    34523975    }
    … …  
    34583981        global $members_template;
    34593982
     3983        /**
     3984         * Filters whether the member is banned from the current group.
     3985         *
     3986         * @since BuddyPress (1.0.0)
     3987         *
     3988         * @param bool $is_banned Whether or not the member is banned.
     3989         */
    34603990        return apply_filters( 'bp_get_group_member_is_banned', $members_template->member->is_banned );
    34613991    }
    … …  
    34643994    global $members_template;
    34653995
    3466     if ( $members_template->member->is_banned )
     3996    if ( $members_template->member->is_banned ) {
     3997
     3998        /**
     3999         * Filters the class to add to the HTML if member is banned.
     4000         *
     4001         * @since BuddyPress (1.2.6)
     4002         *
     4003         * @param string $value HTML class to add.
     4004         */
    34674005        echo apply_filters( 'bp_group_member_css_class', 'banned-user' );
     4006    }
    34684007}
    34694008
    … …  
    34744013        global $members_template;
    34754014
     4015        /**
     4016         * Filters the joined since time for the current member in the loop.
     4017         *
     4018         * @since BuddyPress (1.0.0)
     4019         *
     4020         * @param string $value Joined since time.
     4021         */
    34764022        return apply_filters( 'bp_get_group_member_joined_since', bp_core_get_last_activity( $members_template->member->date_modified, __( 'joined %s', 'buddypress') ) );
    34774023    }
    … …  
    34834029        global $members_template;
    34844030
     4031        /**
     4032         * Filters the member's user ID for group members loop.
     4033         *
     4034         * @since BuddyPress (1.0.0)
     4035         *
     4036         * @param int $user_id User ID of the member.
     4037         */
    34854038        return apply_filters( 'bp_get_group_member_id', $members_template->member->user_id );
    34864039    }
    … …  
    34994052}
    35004053    function bp_get_group_pag_id() {
     4054
     4055        /**
     4056         * Filters the string to be used as the group pag id.
     4057         *
     4058         * @since BuddyPress (1.0.0)
     4059         *
     4060         * @param string $value Value to use for the pag id.
     4061         */
    35014062        return apply_filters( 'bp_get_group_pag_id', 'pag' );
    35024063    }
    … …  
    35084069    function bp_get_group_member_pagination() {
    35094070        global $members_template;
     4071
     4072        /**
     4073         * Filters the HTML markup to be used for group member listing pagination.
     4074         *
     4075         * @since BuddyPress (1.0.0)
     4076         *
     4077         * @param string $pag_links HTML markup for the pagination.
     4078         */
    35104079        return apply_filters( 'bp_get_group_member_pagination', $members_template->pag_links );
    35114080    }
    … …  
    35224091        $total = bp_core_number_format( $members_template->total_member_count );
    35234092
     4093        /**
     4094         * Filters the "Viewing x-y of z members" pagination message.
     4095         *
     4096         * @since BuddyPress (1.0.0)
     4097         *
     4098         * @param string $value    "Viewing x-y of z members" text.
     4099         * @param string $from_num Total amount for the low value in the range.
     4100         * @param string $to_num   Total amount for the high value in the range.
     4101         * @param string $total    Total amount of members found.
     4102         */
    35244103        return apply_filters( 'bp_get_group_member_pagination_count', sprintf( _n( 'Viewing 1 member', 'Viewing %1$s - %2$s of %3$s members', $total, 'buddypress' ), $from_num, $to_num, $total ), $from_num, $to_num, $total );
    35254104    }
    … …  
    35384117 * Output the Group members template
    35394118 *
    3540  * @since BuddyPress (?)
     4119 * @since BuddyPress (2.0.0)
    35414120 *
    35424121 * @return string html output
    … …  
    35514130
    35524131            <?php bp_groups_members_filter(); ?>
    3553             <?php do_action( 'bp_members_directory_member_sub_types' ); ?>
     4132            <?php
     4133
     4134            /**
     4135             * Fires at the end of the group members search unordered list.
     4136             *
     4137             * Part of bp_groups_members_template_part().
     4138             *
     4139             * @since BuddyPress (1.5.0)
     4140             */
     4141            do_action( 'bp_members_directory_member_sub_types' ); ?>
    35544142
    35554143        </ul>
    … …  
    35674155 * Output the Group members filters
    35684156 *
    3569  * @since BuddyPress (?)
     4157 * @since BuddyPress (2.0.0)
    35704158 *
    35714159 * @return string html output
    … …  
    35854173            <option value="alphabetical"><?php _e( 'Alphabetical', 'buddypress' ); ?></option>
    35864174
    3587             <?php do_action( 'bp_groups_members_order_options' ); ?>
     4175            <?php
     4176
     4177            /**
     4178             * Fires at the end of the Group members filters select input.
     4179             *
     4180             * Useful for plugins to add more filter options.
     4181             *
     4182             * @since BuddyPress (2.0.0)
     4183             */
     4184            do_action( 'bp_groups_members_order_options' ); ?>
    35884185
    35894186        </select>
    … …  
    36224219        $can_create = false;
    36234220
     4221    /**
     4222     * Filters if the current logged in user can create groups.
     4223     *
     4224     * @since BuddyPress (1.5.0)
     4225     *
     4226     * @param bool $can_create Whether the person can create groups.
     4227     * @param int  $restricted Whether or not group creation is restricted.
     4228     */
    36244229    return apply_filters( 'bp_user_can_create_groups', $can_create, $restricted );
    36254230}
    … …  
    36474252    unset( $is_enabled );
    36484253
     4254    /**
     4255     * Fires at the end of the creation of the group tabs.
     4256     *
     4257     * @since BuddyPress (1.0.0)
     4258     */
    36494259    do_action( 'groups_creation_tabs' );
    36504260}
    … …  
    36534263    $bp = buddypress();
    36544264
     4265    /**
     4266     * Filters the group creation stage title.
     4267     *
     4268     * @since BuddyPress (1.1.0)
     4269     *
     4270     * @param string $value HTML markup for the group creation stage title.
     4271     */
    36554272    echo apply_filters( 'bp_group_creation_stage_title', '<span>&mdash; ' . $bp->groups->group_creation_steps[bp_get_groups_current_create_step()]['name'] . '</span>' );
    36564273}
    … …  
    36674284        }
    36684285
     4286        /**
     4287         * Filters the group creation form action.
     4288         *
     4289         * @since BuddyPress (1.1.0)
     4290         *
     4291         * @param string $value Action to be used with group creation form.
     4292         */
    36694293        return apply_filters( 'bp_get_group_creation_form_action', trailingslashit( bp_get_groups_directory_permalink() . 'create/step/' . bp_action_variable( 1 ) ) );
    36704294    }
    … …  
    37514375            $new_group_id = 0;
    37524376
     4377        /**
     4378         * Filters the new group ID.
     4379         *
     4380         * @since BuddyPress (1.1.0)
     4381         *
     4382         * @param int $new_group_id ID of the new group.
     4383         */
    37534384        return apply_filters( 'bp_get_new_group_id', $new_group_id );
    37544385    }
    … …  
    37654396            $name = '';
    37664397
     4398        /**
     4399         * Filters the new group name.
     4400         *
     4401         * @since BuddyPress (1.1.0)
     4402         *
     4403         * @param string $name Name of the new group.
     4404         */
    37674405        return apply_filters( 'bp_get_new_group_name', $name );
    37684406    }
    … …  
    37794417            $description = '';
    37804418
     4419        /**
     4420         * Filters the new group description.
     4421         *
     4422         * @since BuddyPress (1.1.0)
     4423         *
     4424         * @param string $name Description of the new group.
     4425         */
    37814426        return apply_filters( 'bp_get_new_group_description', $description );
    37824427    }
    … …  
    37884433        $bp = buddypress();
    37894434
     4435        /**
     4436         * Filters whether or not to enable forums for the new group.
     4437         *
     4438         * @since BuddyPress (1.1.0)
     4439         *
     4440         * @param int $enable_forum Whether or not to enable forums.
     4441         */
    37904442        return (int) apply_filters( 'bp_get_new_group_enable_forum', $bp->groups->current_group->enable_forum );
    37914443    }
    … …  
    37974449        $bp = buddypress();
    37984450
     4451        /**
     4452         * Filters the new group status.
     4453         *
     4454         * @since BuddyPress (1.1.0)
     4455         *
     4456         * @param string $status Status for the new group.
     4457         */
    37994458        return apply_filters( 'bp_get_new_group_status', $bp->groups->current_group->status );
    38004459    }
    … …  
    38194478        extract( $r, EXTR_SKIP );
    38204479
     4480        /**
     4481         * Filters the new group avatar.
     4482         *
     4483         * @since BuddyPress (1.1.0)
     4484         *
     4485         * @param string $value HTML markup for the new group avatar.
     4486         */
    38214487        return apply_filters( 'bp_get_new_group_avatar', bp_core_fetch_avatar( array( 'item_id' => $bp->groups->current_group->id, 'object' => 'group', 'type' => $type, 'avatar_dir' => 'group-avatars', 'alt' => $alt, 'width' => $width, 'height' => $height, 'class' => $class, 'no_grav' => $no_grav ) ) );
    38224488    }
    … …  
    38354501        }
    38364502
     4503        /**
     4504         * Filters the permalink for the previous step with the group creation process.
     4505         *
     4506         * @since BuddyPress (1.1.0)
     4507         *
     4508         * @param string $value Permalink for the previous step.
     4509         */
    38374510        return apply_filters( 'bp_get_group_creation_previous_link', trailingslashit( bp_get_groups_directory_permalink() . 'create/step/' . array_pop( $previous_steps ) ) );
    38384511    }
    … …  
    38634536        }
    38644537
     4538        /**
     4539         * Filters the current group creation step.
     4540         *
     4541         * If none is found, returns an empty string.
     4542         *
     4543         * @since BuddyPress (1.6.0)
     4544         *
     4545         * @param string $current_create_step Current step in the group creation process.
     4546         */
    38654547        return apply_filters( 'bp_get_groups_current_create_step', $current_create_step );
    38664548    }
    … …  
    39414623    </form>';
    39424624
     4625    /**
     4626     * Filters the HTML markup for the groups search form.
     4627     *
     4628     * @since BuddyPress (1.9.0)
     4629     *
     4630     * @param string $search_form_html HTML markup for the search form.
     4631     */
    39434632    echo apply_filters( 'bp_directory_groups_search_form', $search_form_html );
    39444633
    … …  
    40304719        }
    40314720
     4721        /**
     4722         * Filters the current group admin tab slug.
     4723         *
     4724         * @since BuddyPress (1.6.0)
     4725         *
     4726         * @param string $tab Current group admin tab slug.
     4727         */
    40324728        return apply_filters( 'bp_get_current_group_admin_tab', $tab );
    40334729    }
    … …  
    40664762        ) );
    40674763
     4764        /**
     4765         * Filters the current group avatar.
     4766         *
     4767         * @since BuddyPress (2.0.0)
     4768         *
     4769         * @param string $group_avatar HTML markup for current group avatar.
     4770         */
    40684771        return apply_filters( 'bp_get_group_current_avatar', $group_avatar );
    40694772    }
    … …  
    41034806        $bp = buddypress();
    41044807
     4808        /**
     4809         * Filters the URL to delete the group avatar.
     4810         *
     4811         * @since BuddyPress (1.1.0)
     4812         *
     4813         * @param string $value URL to delete the group avatar.
     4814         */
    41054815        return apply_filters( 'bp_get_group_avatar_delete_link', wp_nonce_url( bp_get_group_permalink( $bp->groups->current_group ) . 'admin/group-avatar/delete', 'bp_group_avatar_delete' ) );
    41064816    }
    … …  
    42604970            return true;
    42614971        } elseif ( $tick == $this->request_count ) {
     4972
     4973            /**
     4974             * Fires right before the rewinding of group membership requests list.
     4975             *
     4976             * @since BuddyPress (1.5.0)
     4977             */
    42624978            do_action( 'group_request_loop_end' );
    42634979            // Do some cleaning up after the loop
    … …  
    42754991        // loop has just started
    42764992        if ( 0 == $this->current_request ) {
     4993
     4994            /**
     4995             * Fires if the current group membership request item is the first in the loop.
     4996             *
     4997             * @since BuddyPress (1.1.0)
     4998             */
    42774999            do_action( 'group_request_loop_start' );
    42785000        }
    … …  
    43045026
    43055027    $requests_template = new BP_Groups_Membership_Requests_Template( $r );
     5028
     5029    /**
     5030     * Filters whether or not a group membership query has requests to display.
     5031     *
     5032     * @since BuddyPress (1.1.0)
     5033     *
     5034     * @param bool                                   $value             Whether there are requests to display.
     5035     * @param BP_Groups_Membership_Requests_Template $requests_template Object holding the requests query results.
     5036     */
    43065037    return apply_filters( 'bp_group_has_membership_requests', $requests_template->has_requests(), $requests_template );
    43075038}
    … …  
    43225053    global $requests_template;
    43235054
     5055    /**
     5056     * Filters the requesting user's avatar thumbnail.
     5057     *
     5058     * @since BuddyPress (1.0.0)
     5059     *
     5060     * @param string $value HTML markup for the user's avatar thumbnail.
     5061     */
    43245062    echo apply_filters( 'bp_group_request_user_avatar_thumb', bp_core_fetch_avatar( array( 'item_id' => $requests_template->request->user_id, 'type' => 'thumb', 'alt' => sprintf( __( 'Profile picture of %s', 'buddypress' ), bp_core_get_user_displayname( $requests_template->request->user_id ) ) ) ) );
    43255063}
    … …  
    43315069        global $requests_template;
    43325070
     5071        /**
     5072         * Filters the URL to use to reject a membership request.
     5073         *
     5074         * @since BuddyPress (1.2.6)
     5075         *
     5076         * @param string $value URL to use to reject a membership request.
     5077         */
    43335078        return apply_filters( 'bp_get_group_request_reject_link', wp_nonce_url( bp_get_group_permalink( groups_get_current_group() ) . 'admin/membership-requests/reject/' . $requests_template->request->membership_id, 'groups_reject_membership_request' ) );
    43345079    }
    … …  
    43405085        global $requests_template;
    43415086
     5087        /**
     5088         * Filters the URL to use to accept a membership request.
     5089         *
     5090         * @since BuddyPress (1.2.6)
     5091         *
     5092         * @param string $value URL to use to accept a membership request.
     5093         */
    43425094        return apply_filters( 'bp_get_group_request_accept_link', wp_nonce_url( bp_get_group_permalink( groups_get_current_group() ) . 'admin/membership-requests/accept/' . $requests_template->request->membership_id, 'groups_accept_membership_request' ) );
    43435095    }
    … …  
    43495101        global $requests_template;
    43505102
     5103        /**
     5104         * Filters the URL for the user requesting membership.
     5105         *
     5106         * @since BuddyPress (1.2.6)
     5107         *
     5108         * @param string $value URL for the user requestion membership.
     5109         */
    43515110        return apply_filters( 'bp_get_group_request_user_link', bp_core_get_userlink( $requests_template->request->user_id ) );
    43525111    }
    … …  
    43555114    global $requests_template;
    43565115
     5116    /**
     5117     * Filters the formatted time since membership was requested.
     5118     *
     5119     * @since BuddyPress (1.0.0)
     5120     *
     5121     * @param string $value Formatted time since membership was requested.
     5122     */
    43575123    echo apply_filters( 'bp_group_request_time_since_requested', sprintf( __( 'requested %s', 'buddypress' ), bp_core_time_since( strtotime( $requests_template->request->date_modified ) ) ) );
    43585124}
    … …  
    43615127    global $requests_template;
    43625128
     5129    /**
     5130     * Filters the membership request comment left by user.
     5131     *
     5132     * @since BuddyPress (1.0.0)
     5133     *
     5134     * @param string $value Membership request comment left by user.
     5135     */
    43635136    echo apply_filters( 'bp_group_request_comment', strip_tags( stripslashes( $requests_template->request->comments ) ) );
    43645137}
    … …  
    43815154    function bp_get_group_requests_pagination_links() {
    43825155        global $requests_template;
     5156
     5157        /**
     5158         * Filters pagination links for group membership requests.
     5159         *
     5160         * @since BuddyPress (2.0.0)
     5161         *
     5162         * @param string $value Pagination links for group membership requests.
     5163         */
    43835164        return apply_filters( 'bp_get_group_requests_pagination_links', $requests_template->pag_links );
    43845165    }
    … …  
    44075188        $total     = bp_core_number_format( $requests_template->total_request_count );
    44085189
     5190        /**
     5191         * Filters pagination count text for group membership requests.
     5192         *
     5193         * @since BuddyPress (2.0.0)
     5194         *
     5195         * @param string $value Pagination count text for group membership requests.
     5196         */
    44095197        return apply_filters( 'bp_get_group_requests_pagination_count', sprintf( _n( 'Viewing 1 request', 'Viewing %1$s - %2$s of %3$s requests', $total, 'buddypress' ), $from_num, $to_num, $total ), $from_num, $to_num, $total );
    44105198    }
    … …  
    45955383
    45965384    $invites_template = new BP_Groups_Invite_Template( $r );
     5385
     5386    /**
     5387     * Filters whether or not a group invites query has invites to display.
     5388     *
     5389     * @since BuddyPress (1.1.0)
     5390     *
     5391     * @param bool                      $value            Whether there are requests to display.
     5392     * @param BP_Groups_Invite_Template $invites_template Object holding the invites query results.
     5393     */
    45975394    return apply_filters( 'bp_group_has_invites', $invites_template->has_invites(), $invites_template );
    45985395}
    … …  
    46165413        global $invites_template;
    46175414
     5415        /**
     5416         * Filters the group invite item ID.
     5417         *
     5418         * @since BuddyPress (1.1.0)
     5419         *
     5420         * @param string $value Group invite item ID.
     5421         */
    46185422        return apply_filters( 'bp_get_group_invite_item_id', 'uid-' . $invites_template->invite->user->id );
    46195423    }
    … …  
    46255429        global $invites_template;
    46265430
     5431        /**
     5432         * Filters the group invite user avatar.
     5433         *
     5434         * @since BuddyPress (1.1.0)
     5435         *
     5436         * @param string $value Group invite user avatar.
     5437         */
    46275438        return apply_filters( 'bp_get_group_invite_user_avatar', $invites_template->invite->user->avatar_thumb );
    46285439    }
    … …  
    46345445        global $invites_template;
    46355446
     5447        /**
     5448         * Filters the group invite user link.
     5449         *
     5450         * @since BuddyPress (1.1.0)
     5451         *
     5452         * @param string $value Group invite user link.
     5453         */
    46365454        return apply_filters( 'bp_get_group_invite_user_link', bp_core_get_userlink( $invites_template->invite->user->id ) );
    46375455    }
    … …  
    46435461        global $invites_template;
    46445462
     5463        /**
     5464         * Filters the group invite user's last active time.
     5465         *
     5466         * @since BuddyPress (1.1.0)
     5467         *
     5468         * @param string $value Group invite user's last active time.
     5469         */
    46455470        return apply_filters( 'bp_get_group_invite_user_last_active', $invites_template->invite->user->last_active );
    46465471    }
    … …  
    46805505    function bp_get_group_invite_pagination_links() {
    46815506        global $invites_template;
     5507
     5508        /**
     5509         * Filters the pagination links for group invitations.
     5510         *
     5511         * @since BuddyPress (2.0.0)
     5512         *
     5513         * @param string $value Pagination links for group invitations.
     5514         */
    46825515        return apply_filters( 'bp_get_group_invite_pagination_links', $invites_template->pag_links );
    46835516    }
    … …  
    47065539        $total     = bp_core_number_format( $invites_template->total_invite_count );
    47075540
     5541        /** This filter is documented in bp-groups/bp-groups-template.php */
    47085542        return apply_filters( 'bp_get_groups_pagination_count', sprintf( _n( 'Viewing 1 invitation', 'Viewing %1$s - %2$s of %3$s invitations', $total, 'buddypress' ), $from_num, $to_num, $total ), $from_num, $to_num, $total );
    47095543    }
    … …  
    47305564
    47315565/**
    4732  * Output the current group activity-stream RSS url
     5566 * Output the current group activity-stream RSS URL
    47335567 *
    47345568 * @since BuddyPress (1.5.0)
    … …  
    47385572}
    47395573    /**
    4740      * Return the current group activity-stream RSS url
     5574     * Return the current group activity-stream RSS URL
    47415575     *
    47425576     * @since BuddyPress (1.5.0)
    … …  
    47485582        $feed_link     = trailingslashit( $group_link );
    47495583
     5584        /**
     5585         * Filters the current group activity-stream RSS URL.
     5586         *
     5587         * @since BuddyPress (1.2.0)
     5588         *
     5589         * @param string $feed_link Current group activity-stream RSS URL.
     5590         */
    47505591        return apply_filters( 'bp_get_group_activity_feed_link', $feed_link );
    47515592    }
    … …  
    47735614        $current_group_id = isset( $current_group->id ) ? (int) $current_group->id : 0;
    47745615
     5616        /**
     5617         * Filters the ID of the current group.
     5618         *
     5619         * @since BuddyPress (1.5.0)
     5620         *
     5621         * @param int    $current_group_id ID of the current group.
     5622         * @param object $current_group    Instance holding the current group.
     5623         */
    47755624        return apply_filters( 'bp_get_current_group_id', $current_group_id, $current_group );
    47765625    }
    … …  
    47965645        $current_group_slug = isset( $current_group->slug ) ? $current_group->slug : '';
    47975646
     5647        /**
     5648         * Filters the slug of the current group.
     5649         *
     5650         * @since BuddyPress (1.5.0)
     5651         *
     5652         * @param string $current_group_slug Slug of the current group.
     5653         * @param object $current_group      Instance holding the current group.
     5654         */
    47985655        return apply_filters( 'bp_get_current_group_slug', $current_group_slug, $current_group );
    47995656    }
    … …  
    48185675        $current_group      = groups_get_current_group();
    48195676        $current_group_name = isset( $current_group->name ) ? $current_group->name : '';
     5677
     5678        /** This filter is documented in bp-groups/bp-groups-template.php */
    48205679        $name               = apply_filters( 'bp_get_group_name', $current_group_name );
    48215680
     5681        /**
     5682         * Filters the name of the current group.
     5683         *
     5684         * @since BuddyPress (1.2.0)
     5685         *
     5686         * @param string $name          Name of the current group.
     5687         * @param object $current_group Instance holding the current group.
     5688         */
    48225689        return apply_filters( 'bp_get_current_group_name', $name, $current_group );
    48235690    }
    … …  
    48435710        $current_group      = groups_get_current_group();
    48445711        $current_group_desc = isset( $current_group->description ) ? $current_group->description : '';
     5712
     5713        /**
     5714         * Filters the description of the current group.
     5715         *
     5716         * This filter is used to apply extra filters related to formatting.
     5717         *
     5718         * @since BuddyPress (1.0.0)
     5719         *
     5720         * @param string $current_group_desc Description of the current group.
     5721         */
    48455722        $desc               = apply_filters( 'bp_get_group_description', $current_group_desc );
    48465723
     5724        /**
     5725         * Filters the description of the current group.
     5726         *
     5727         * @since BuddyPress (2.1.0)
     5728         *
     5729         * @param string $desc Description of the current group.
     5730         */
    48475731        return apply_filters( 'bp_get_current_group_description', $desc );
    48485732    }
    … …  
    49025786        }
    49035787
    4904         // Return the url
     5788        /**
     5789         * Filters a URL for a group component action.
     5790         *
     5791         * @since BuddyPress (2.1.0)
     5792         *
     5793         * @param string $url        URL for a group component action.
     5794         * @param string $action     Action being taken for the group.
     5795         * @param string $query_args Query arguments being passed.
     5796         * @param bool   $nonce      Whether or not to add a nonce.
     5797         */
    49055798        return apply_filters( 'bp_get_groups_action_link', $url, $action, $query_args, $nonce );
    49065799    }
    … …  
    49565849    }
    49575850
    4958     // Filter and return
     5851    /**
     5852     * Filters the number of groups in user's profile.
     5853     *
     5854     * @since BuddyPress (2.0.0)
     5855     *
     5856     * @param string $value HTML for stats output.
     5857     * @param array  $r     Array of parsed arguments for query.
     5858     */
    49595859    return apply_filters( 'bp_groups_get_profile_stats', $r['output'], $r );
    49605860}
Note: See TracChangeset for help on using the changeset viewer.