Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
04/28/2015 01:52:18 AM (10 years ago)
Author:
tw2113
Message:

Adds hooks documentation for the members template files.

Fixes #5948.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-templates/bp-legacy/buddypress/members/register.php

    r9604 r9814  
    11<div id="buddypress">
    22
    3     <?php do_action( 'bp_before_register_page' ); ?>
     3    <?php
     4
     5    /**
     6     * Fires at the top of the BuddyPress member registration page template.
     7     *
     8     * @since BuddyPress (1.1.0)
     9     */
     10    do_action( 'bp_before_register_page' ); ?>
    411
    512    <div class="page" id="register-page">
    … …  
    815
    916        <?php if ( 'registration-disabled' == bp_get_current_signup_step() ) : ?>
    10             <?php do_action( 'template_notices' ); ?>
    11             <?php do_action( 'bp_before_registration_disabled' ); ?>
     17            <?php
     18
     19            /** This action is documented in bp-templates/bp-legacy/buddypress/activity/index.php */
     20            do_action( 'template_notices' ); ?>
     21            <?php
     22
     23            /**
     24             * Fires before the display of the registration disabled message.
     25             *
     26             * @since BuddyPress (1.5.0)
     27             */
     28            do_action( 'bp_before_registration_disabled' ); ?>
    1229
    1330                <p><?php _e( 'User registration is currently not allowed.', 'buddypress' ); ?></p>
    1431
    15             <?php do_action( 'bp_after_registration_disabled' ); ?>
     32            <?php
     33
     34            /**
     35             * Fires after the display of the registration disabled message.
     36             *
     37             * @since BuddyPress (1.5.0)
     38             */
     39            do_action( 'bp_after_registration_disabled' ); ?>
    1640        <?php endif; // registration-disabled signup step ?>
    1741
    1842        <?php if ( 'request-details' == bp_get_current_signup_step() ) : ?>
    1943
    20             <?php do_action( 'template_notices' ); ?>
     44            <?php
     45
     46            /** This action is documented in bp-templates/bp-legacy/buddypress/activity/index.php */
     47            do_action( 'template_notices' ); ?>
    2148
    2249            <p><?php _e( 'Registering for this site is easy. Just fill in the fields below, and we\'ll get a new account set up for you in no time.', 'buddypress' ); ?></p>
    2350
    24             <?php do_action( 'bp_before_account_details_fields' ); ?>
     51            <?php
     52
     53            /**
     54             * Fires before the display of member registration account details fields.
     55             *
     56             * @since BuddyPress (1.1.0)
     57             */
     58            do_action( 'bp_before_account_details_fields' ); ?>
    2559
    2660            <div class="register-section" id="basic-details-section">
    … …  
    3165
    3266                <label for="signup_username"><?php _e( 'Username', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
    33                 <?php do_action( 'bp_signup_username_errors' ); ?>
     67                <?php
     68
     69                /**
     70                 * Fires and displays any member registration username errors.
     71                 *
     72                 * @since BuddyPress (1.1.0)
     73                 */
     74                do_action( 'bp_signup_username_errors' ); ?>
    3475                <input type="text" name="signup_username" id="signup_username" value="<?php bp_signup_username_value(); ?>" <?php bp_form_field_attributes( 'username' ); ?>/>
    3576
    3677                <label for="signup_email"><?php _e( 'Email Address', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
    37                 <?php do_action( 'bp_signup_email_errors' ); ?>
     78                <?php
     79
     80                /**
     81                 * Fires and displays any member registration email errors.
     82                 *
     83                 * @since BuddyPress (1.1.0)
     84                 */
     85                do_action( 'bp_signup_email_errors' ); ?>
    3886                <input type="email" name="signup_email" id="signup_email" value="<?php bp_signup_email_value(); ?>" <?php bp_form_field_attributes( 'email' ); ?>/>
    3987
    4088                <label for="signup_password"><?php _e( 'Choose a Password', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
    41                 <?php do_action( 'bp_signup_password_errors' ); ?>
     89                <?php
     90
     91                /**
     92                 * Fires and displays any member registration password errors.
     93                 *
     94                 * @since BuddyPress (1.1.0)
     95                 */
     96                do_action( 'bp_signup_password_errors' ); ?>
    4297                <input type="password" name="signup_password" id="signup_password" value="" class="password-entry" <?php bp_form_field_attributes( 'password' ); ?>/>
    4398                <div id="pass-strength-result"></div>
    4499
    45100                <label for="signup_password_confirm"><?php _e( 'Confirm Password', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
    46                 <?php do_action( 'bp_signup_password_confirm_errors' ); ?>
     101                <?php
     102
     103                /**
     104                 * Fires and displays any member registration password confirmation errors.
     105                 *
     106                 * @since BuddyPress (1.1.0)
     107                 */
     108                do_action( 'bp_signup_password_confirm_errors' ); ?>
    47109                <input type="password" name="signup_password_confirm" id="signup_password_confirm" value="" class="password-entry-confirm" <?php bp_form_field_attributes( 'password' ); ?>/>
    48110
    49                 <?php do_action( 'bp_account_details_fields' ); ?>
     111                <?php
     112
     113                /**
     114                 * Fires and displays any extra member registration details fields.
     115                 *
     116                 * @since BuddyPress (1.9.0)
     117                 */
     118                do_action( 'bp_account_details_fields' ); ?>
    50119
    51120            </div><!-- #basic-details-section -->
    52121
    53             <?php do_action( 'bp_after_account_details_fields' ); ?>
     122            <?php
     123
     124            /**
     125             * Fires after the display of member registration account details fields.
     126             *
     127             * @since BuddyPress (1.1.0)
     128             */
     129            do_action( 'bp_after_account_details_fields' ); ?>
    54130
    55131            <?php /***** Extra Profile Details ******/ ?>
    … …  
    57133            <?php if ( bp_is_active( 'xprofile' ) ) : ?>
    58134
    59                 <?php do_action( 'bp_before_signup_profile_fields' ); ?>
     135                <?php
     136
     137                /**
     138                 * Fires before the display of member registration xprofile fields.
     139                 *
     140                 * @since BuddyPress (1.2.4)
     141                 */
     142                do_action( 'bp_before_signup_profile_fields' ); ?>
    60143
    61144                <div class="register-section" id="profile-details-section">
    … …  
    74157                            $field_type->edit_field_html();
    75158
     159                            /**
     160                             * Fires before the display of the visibility options for xprofile fields.
     161                             *
     162                             * @since BuddyPress (1.7.0)
     163                             */
    76164                            do_action( 'bp_custom_profile_edit_fields_pre_visibility' );
    77165
    … …  
    97185                            <?php endif ?>
    98186
    99                             <?php do_action( 'bp_custom_profile_edit_fields' ); ?>
     187                            <?php
     188
     189                            /**
     190                             * Fires after the display of the visibility options for xprofile fields.
     191                             *
     192                             * @since BuddyPress (1.1.0)
     193                             */
     194                            do_action( 'bp_custom_profile_edit_fields' ); ?>
    100195
    101196                            <p class="description"><?php bp_the_profile_field_description(); ?></p>
    … …  
    109204                    <?php endwhile; endif; endif; ?>
    110205
    111                     <?php do_action( 'bp_signup_profile_fields' ); ?>
     206                    <?php
     207
     208                    /**
     209                     * Fires and displays any extra member registration xprofile fields.
     210                     *
     211                     * @since BuddyPress (1.9.0)
     212                     */
     213                    do_action( 'bp_signup_profile_fields' ); ?>
    112214
    113215                </div><!-- #profile-details-section -->
    114216
    115                 <?php do_action( 'bp_after_signup_profile_fields' ); ?>
     217                <?php
     218
     219                /**
     220                 * Fires after the display of member registration xprofile fields.
     221                 *
     222                 * @since BuddyPress (1.1.0)
     223                 */
     224                do_action( 'bp_after_signup_profile_fields' ); ?>
    116225
    117226            <?php endif; ?>
    … …  
    119228            <?php if ( bp_get_blog_signup_allowed() ) : ?>
    120229
    121                 <?php do_action( 'bp_before_blog_details_fields' ); ?>
     230                <?php
     231
     232                /**
     233                 * Fires before the display of member registration blog details fields.
     234                 *
     235                 * @since BuddyPress (1.1.0)
     236                 */
     237                do_action( 'bp_before_blog_details_fields' ); ?>
    122238
    123239                <?php /***** Blog Creation Details ******/ ?>
    … …  
    132248
    133249                        <label for="signup_blog_url"><?php _e( 'Blog URL', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
    134                         <?php do_action( 'bp_signup_blog_url_errors' ); ?>
     250                        <?php
     251
     252                        /**
     253                         * Fires and displays any member registration blog URL errors.
     254                         *
     255                         * @since BuddyPress (1.1.0)
     256                         */
     257                        do_action( 'bp_signup_blog_url_errors' ); ?>
    135258
    136259                        <?php if ( is_subdomain_install() ) : ?>
    … …  
    141264
    142265                        <label for="signup_blog_title"><?php _e( 'Site Title', 'buddypress' ); ?> <?php _e( '(required)', 'buddypress' ); ?></label>
    143                         <?php do_action( 'bp_signup_blog_title_errors' ); ?>
     266                        <?php
     267
     268                        /**
     269                         * Fires and displays any member registration blog title errors.
     270                         *
     271                         * @since BuddyPress (1.1.0)
     272                         */
     273                        do_action( 'bp_signup_blog_title_errors' ); ?>
    144274                        <input type="text" name="signup_blog_title" id="signup_blog_title" value="<?php bp_signup_blog_title_value(); ?>" />
    145275
    146276                        <span class="label"><?php _e( 'I would like my site to appear in search engines, and in public listings around this network.', 'buddypress' ); ?></span>
    147                         <?php do_action( 'bp_signup_blog_privacy_errors' ); ?>
     277                        <?php
     278
     279                        /**
     280                         * Fires and displays any member registration blog privacy errors.
     281                         *
     282                         * @since BuddyPress (1.1.0)
     283                         */
     284                        do_action( 'bp_signup_blog_privacy_errors' ); ?>
    148285
    149286                        <label><input type="radio" name="signup_blog_privacy" id="signup_blog_privacy_public" value="public"<?php if ( 'public' == bp_get_signup_blog_privacy_value() || !bp_get_signup_blog_privacy_value() ) : ?> checked="checked"<?php endif; ?> /> <?php _e( 'Yes', 'buddypress' ); ?></label>
    150287                        <label><input type="radio" name="signup_blog_privacy" id="signup_blog_privacy_private" value="private"<?php if ( 'private' == bp_get_signup_blog_privacy_value() ) : ?> checked="checked"<?php endif; ?> /> <?php _e( 'No', 'buddypress' ); ?></label>
    151288
    152                         <?php do_action( 'bp_blog_details_fields' ); ?>
     289                        <?php
     290
     291                        /**
     292                         * Fires and displays any extra member registration blog details fields.
     293                         *
     294                         * @since BuddyPress (1.9.0)
     295                         */
     296                        do_action( 'bp_blog_details_fields' ); ?>
    153297
    154298                    </div>
    … …  
    156300                </div><!-- #blog-details-section -->
    157301
    158                 <?php do_action( 'bp_after_blog_details_fields' ); ?>
     302                <?php
     303
     304                /**
     305                 * Fires after the display of member registration blog details fields.
     306                 *
     307                 * @since BuddyPress (1.1.0)
     308                 */
     309                do_action( 'bp_after_blog_details_fields' ); ?>
    159310
    160311            <?php endif; ?>
    161312
    162             <?php do_action( 'bp_before_registration_submit_buttons' ); ?>
     313            <?php
     314
     315            /**
     316             * Fires before the display of the registration submit buttons.
     317             *
     318             * @since BuddyPress (1.1.0)
     319             */
     320            do_action( 'bp_before_registration_submit_buttons' ); ?>
    163321
    164322            <div class="submit">
    … …  
    166324            </div>
    167325
    168             <?php do_action( 'bp_after_registration_submit_buttons' ); ?>
     326            <?php
     327
     328            /**
     329             * Fires after the display of the registration submit buttons.
     330             *
     331             * @since BuddyPress (1.1.0)
     332             */
     333            do_action( 'bp_after_registration_submit_buttons' ); ?>
    169334
    170335            <?php wp_nonce_field( 'bp_new_signup' ); ?>
    … …  
    174339        <?php if ( 'completed-confirmation' == bp_get_current_signup_step() ) : ?>
    175340
    176             <?php do_action( 'template_notices' ); ?>
    177             <?php do_action( 'bp_before_registration_confirmed' ); ?>
     341            <?php
     342
     343            /** This action is documented in bp-templates/bp-legacy/buddypress/activity/index.php */
     344            do_action( 'template_notices' ); ?>
     345            <?php
     346
     347            /**
     348             * Fires before the display of the registration confirmed messages.
     349             *
     350             * @since BuddyPress (1.5.0)
     351             */
     352            do_action( 'bp_before_registration_confirmed' ); ?>
    178353
    179354            <?php if ( bp_registration_needs_activation() ) : ?>
    … …  
    183358            <?php endif; ?>
    184359
    185             <?php do_action( 'bp_after_registration_confirmed' ); ?>
     360            <?php
     361
     362            /**
     363             * Fires after the display of the registration confirmed messages.
     364             *
     365             * @since BuddyPress (1.5.0)
     366             */
     367            do_action( 'bp_after_registration_confirmed' ); ?>
    186368
    187369        <?php endif; // completed-confirmation signup step ?>
    188370
    189         <?php do_action( 'bp_custom_signup_steps' ); ?>
     371        <?php
     372
     373        /**
     374         * Fires and displays any custom signup steps.
     375         *
     376         * @since BuddyPress (1.1.0)
     377         */
     378        do_action( 'bp_custom_signup_steps' ); ?>
    190379
    191380        </form>
    … …  
    193382    </div>
    194383
    195     <?php do_action( 'bp_after_register_page' ); ?>
     384    <?php
     385
     386    /**
     387     * Fires at the bottom of the BuddyPress member registration page template.
     388     *
     389     * @since BuddyPress (1.1.0)
     390     */
     391    do_action( 'bp_after_register_page' ); ?>
    196392
    197393</div><!-- #buddypress -->
Note: See TracChangeset for help on using the changeset viewer.