Skip to:
Content

BuddyPress.org


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.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • 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() {
Note: See TracChangeset for help on using the changeset viewer.