Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
04/23/2015 05:08:50 AM (9 years ago)
Author:
tw2113
Message:

Adds hooks documentation for the groups template files.

See #5948.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-templates/bp-legacy/buddypress/groups/create.php

    r9757 r9786  
    1 <?php do_action( 'bp_before_create_group_page' ); ?>
     1<?php
     2
     3/**
     4 * Fires at the top of the groups creation template file.
     5 *
     6 * @since BuddyPress (1.7.0)
     7 */
     8do_action( 'bp_before_create_group_page' ); ?>
    29
    310<div id="buddypress">
    411
    5     <?php do_action( 'bp_before_create_group_content_template' ); ?>
     12    <?php
     13
     14    /**
     15     * Fires before the display of group creation content.
     16     *
     17     * @since BuddyPress (1.6.0)
     18     */
     19    do_action( 'bp_before_create_group_content_template' ); ?>
    620
    721    <form action="<?php bp_group_creation_form_action(); ?>" method="post" id="create-group-form" class="standard-form" enctype="multipart/form-data">
    822
    9         <?php do_action( 'bp_before_create_group' ); ?>
     23        <?php
     24
     25        /**
     26         * Fires before the display of group creation.
     27         *
     28         * @since BuddyPress (1.2.0)
     29         */
     30        do_action( 'bp_before_create_group' ); ?>
    1031
    1132        <div class="item-list-tabs no-ajax" id="group-create-tabs" role="navigation">
    … …  
    2445            <?php if ( bp_is_group_creation_step( 'group-details' ) ) : ?>
    2546
    26                 <?php do_action( 'bp_before_group_details_creation_step' ); ?>
     47                <?php
     48
     49                /**
     50                 * Fires before the display of the group details creation step.
     51                 *
     52                 * @since BuddyPress (1.1.0)
     53                 */
     54                do_action( 'bp_before_group_details_creation_step' ); ?>
    2755
    2856                <div>
    … …  
    3765
    3866                <?php
     67
     68                /**
     69                 * Fires after the display of the group details creation step.
     70                 *
     71                 * @since BuddyPress (1.1.0)
     72                 */
    3973                do_action( 'bp_after_group_details_creation_step' );
    4074                do_action( 'groups_custom_group_fields_editable' ); // @Deprecated
    … …  
    4781            <?php if ( bp_is_group_creation_step( 'group-settings' ) ) : ?>
    4882
    49                 <?php do_action( 'bp_before_group_settings_creation_step' ); ?>
     83                <?php
     84
     85                /**
     86                 * Fires before the display of the group settings creation step.
     87                 *
     88                 * @since BuddyPress (1.1.0)
     89                 */
     90                do_action( 'bp_before_group_settings_creation_step' ); ?>
    5091
    5192                <h4><?php _e( 'Privacy Options', 'buddypress' ); ?></h4>
    … …  
    123164                <?php endif; ?>
    124165
    125                 <?php do_action( 'bp_after_group_settings_creation_step' ); ?>
     166                <?php
     167
     168                /**
     169                 * Fires after the display of the group settings creation step.
     170                 *
     171                 * @since BuddyPress (1.1.0)
     172                 */
     173                do_action( 'bp_after_group_settings_creation_step' ); ?>
    126174
    127175                <?php wp_nonce_field( 'groups_create_save_group-settings' ); ?>
    … …  
    132180            <?php if ( bp_is_group_creation_step( 'group-avatar' ) ) : ?>
    133181
    134                 <?php do_action( 'bp_before_group_avatar_creation_step' ); ?>
     182                <?php
     183
     184                /**
     185                 * Fires before the display of the group avatar creation step.
     186                 *
     187                 * @since BuddyPress (1.1.0)
     188                 */
     189                do_action( 'bp_before_group_avatar_creation_step' ); ?>
    135190
    136191                <?php if ( 'upload-image' == bp_get_avatar_admin_step() ) : ?>
    … …  
    185240                <?php endif; ?>
    186241
    187                 <?php do_action( 'bp_after_group_avatar_creation_step' ); ?>
     242                <?php
     243
     244                /**
     245                 * Fires after the display of the group avatar creation step.
     246                 *
     247                 * @since BuddyPress (1.1.0)
     248                 */
     249                do_action( 'bp_after_group_avatar_creation_step' ); ?>
    188250
    189251                <?php wp_nonce_field( 'groups_create_save_group-avatar' ); ?>
    … …  
    194256            <?php if ( bp_is_group_creation_step( 'group-invites' ) ) : ?>
    195257
    196                 <?php do_action( 'bp_before_group_invites_creation_step' ); ?>
     258                <?php
     259
     260                /**
     261                 * Fires before the display of the group invites creation step.
     262                 *
     263                 * @since BuddyPress (1.1.0)
     264                 */
     265                do_action( 'bp_before_group_invites_creation_step' ); ?>
    197266
    198267                <?php if ( bp_is_active( 'friends' ) && bp_get_total_friend_count( bp_loggedin_user_id() ) ) : ?>
    … …  
    255324                <?php wp_nonce_field( 'groups_create_save_group-invites' ); ?>
    256325
    257                 <?php do_action( 'bp_after_group_invites_creation_step' ); ?>
     326                <?php
     327
     328                /**
     329                 * Fires after the display of the group invites creation step.
     330                 *
     331                 * @since BuddyPress (1.1.0)
     332                 */
     333                do_action( 'bp_after_group_invites_creation_step' ); ?>
    258334
    259335            <?php endif; ?>
    260336
    261             <?php do_action( 'groups_custom_create_steps' ); // Allow plugins to add custom group creation steps ?>
    262 
    263             <?php do_action( 'bp_before_group_creation_step_buttons' ); ?>
     337            <?php
     338
     339            /**
     340             * Fires inside the group admin template.
     341             *
     342             * Allows plugins to add custom group creation steps.
     343             *
     344             * @since BuddyPress (1.1.0)
     345             */
     346            do_action( 'groups_custom_create_steps' ); ?>
     347
     348            <?php
     349
     350            /**
     351             * Fires before the display of the group creation step buttons.
     352             *
     353             * @since BuddyPress (1.1.0)
     354             */
     355            do_action( 'bp_before_group_creation_step_buttons' ); ?>
    264356
    265357            <?php if ( 'crop-image' != bp_get_avatar_admin_step() ) : ?>
    … …  
    298390            <?php endif;?>
    299391
    300             <?php do_action( 'bp_after_group_creation_step_buttons' ); ?>
     392            <?php
     393
     394            /**
     395             * Fires after the display of the group creation step buttons.
     396             *
     397             * @since BuddyPress (1.1.0)
     398             */
     399            do_action( 'bp_after_group_creation_step_buttons' ); ?>
    301400
    302401            <?php /* Don't leave out this hidden field */ ?>
    303402            <input type="hidden" name="group_id" id="group_id" value="<?php bp_new_group_id(); ?>" />
    304403
    305             <?php do_action( 'bp_directory_groups_content' ); ?>
     404            <?php
     405
     406            /**
     407             * Fires and displays the groups directory content.
     408             *
     409             * @since BuddyPress (1.1.0)
     410             */
     411            do_action( 'bp_directory_groups_content' ); ?>
    306412
    307413        </div><!-- .item-body -->
    308414
    309         <?php do_action( 'bp_after_create_group' ); ?>
     415        <?php
     416
     417        /**
     418         * Fires after the display of group creation.
     419         *
     420         * @since BuddyPress (1.2.0)
     421         */
     422        do_action( 'bp_after_create_group' ); ?>
    310423
    311424    </form>
    312425
    313     <?php do_action( 'bp_after_create_group_content_template' ); ?>
     426    <?php
     427
     428    /**
     429     * Fires after the display of group creation content.
     430     *
     431     * @since BuddyPress (1.6.0)
     432     */
     433    do_action( 'bp_after_create_group_content_template' ); ?>
    314434
    315435</div>
    316436
    317 <?php do_action( 'bp_after_create_group_page' ); ?>
     437<?php
     438
     439/**
     440 * Fires at the bottom of the groups creation template file.
     441 *
     442 * @since BuddyPress (1.7.0)
     443 */
     444do_action( 'bp_after_create_group_page' ); ?>
Note: See TracChangeset for help on using the changeset viewer.