Contents

Code Reference Functions bp_core_screen_signup()

bp_core_screen_signup()

Handle the loading of the signup screen.

Description

Source

File: bp-members/screens/register.php

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
function bp_core_screen_signup() {
    $bp = buddypress();
 
    if ( ! bp_is_current_component( 'register' ) || bp_current_action() )
        return;
 
    // Not a directory.
    bp_update_is_directory( false, 'register' );
 
    // If the user is logged in, redirect away from here.
    if ( is_user_logged_in() ) {
 
        $redirect_to = bp_is_component_front_page( 'register' )
            ? bp_get_members_directory_permalink()
            : bp_get_root_domain();
 
        /**
         * Filters the URL to redirect logged in users to when visiting registration page.
         *
         * @since BuddyPress 1.5.1
         *
         * @param string $redirect_to URL to redirect user to.
         */
        bp_core_redirect( apply_filters( 'bp_loggedin_register_page_redirect_to', $redirect_to ) );
 
        return;
    }
 
    $bp->signup->step = 'request-details';
 
    if ( !bp_get_signup_allowed() ) {
        $bp->signup->step = 'registration-disabled';
 
        // If the signup page is submitted, validate and save.
    } elseif ( isset( $_POST['signup_submit'] ) && bp_verify_nonce_request( 'bp_new_signup' ) ) {
 
        /**
         * Fires before the validation of a new signup.
         *
         * @since BuddyPress 2.0.0
         */
        do_action( 'bp_signup_pre_validate' );
 
        // Check the base account details for problems.
        $account_details = bp_core_validate_user_signup( bp_get_signup_username_value(), bp_get_signup_email_value() );
 
        // If there are errors with account details, set them for display.
        if ( !empty( $account_details['errors']->errors['user_name'] ) )
            $bp->signup->errors['signup_username'] = $account_details['errors']->errors['user_name'][0];
 
        if ( !empty( $account_details['errors']->errors['user_email'] ) )
            $bp->signup->errors['signup_email'] = $account_details['errors']->errors['user_email'][0];
 
        // Check that both password fields are filled in.
        if ( empty( $_POST['signup_password'] ) )
            $bp->signup->errors['signup_password'] = __( 'Please make sure to enter your password.', 'buddyboss' );
 
        $bp->signup->username = bp_get_signup_username_value();
        $bp->signup->email = bp_get_signup_email_value();
 
        // Now we've checked account details, we can check profile information.
        if ( bp_is_active( 'xprofile' ) ) {
 
            // Make sure hidden field is passed and populated.
            if ( isset( $_POST['signup_profile_field_ids'] ) && !empty( $_POST['signup_profile_field_ids'] ) ) {
 
                // Let's compact any profile field info into an array.
                $profile_field_ids = explode( ',', $_POST['signup_profile_field_ids'] );
 
                // Loop through the posted fields formatting any datebox values then validate the field.
                foreach ( (array) $profile_field_ids as $field_id ) {
                    bp_xprofile_maybe_format_datebox_post_data( $field_id );
 
                    // Trim post fields.
                    if ( isset( $_POST[ 'field_' . $field_id ] ) ) {
                        if ( is_array( $_POST[ 'field_' . $field_id ] ) ) {
                            $_POST[ 'field_' . $field_id ] = array_map( 'trim', $_POST[ 'field_' . $field_id ] );
                        } else {
                            $_POST[ 'field_' . $field_id ] = trim( $_POST[ 'field_' . $field_id ] );
                        }
                    }
 
                    // Create errors for required fields without values.
                    if ( xprofile_check_is_required_field( $field_id ) && empty( $_POST[ 'field_' . $field_id ] ) && ! bp_current_user_can( 'bp_moderate' ) ) {
                        $bp->signup->errors['field_' . $field_id] = sprintf(
                            '<div class="bp-messages bp-feedback error">
                                <span class="bp-icon" aria-hidden="true"></span>
                                <p>%s</p>
                            </div>',
                            __( 'This is a required field.', 'buddyboss' )
                        );
                    } else
                    // Validate xprofile
                    if ( isset( $_POST[ 'field_' . $field_id ] ) && $message = xprofile_validate_field( $field_id, $_POST[ 'field_' . $field_id ], '' ) ) {
                        $bp->signup->errors['field_' . $field_id] = sprintf(
                            '<div class="bp-messages bp-feedback error">
                                <span class="bp-icon" aria-hidden="true"></span>
                                <p>%s</p>
                            </div>',
                            $message
                        );
                    }
                }
 
                // This situation doesn't naturally occur so bounce to website root.
            } else {
                bp_core_redirect( bp_get_root_domain() );
            }
        }
 
        // Finally, let's check the blog details, if the user wants a blog and blog creation is enabled.
        if ( isset( $_POST['signup_with_blog'] ) ) {
            $active_signup = bp_core_get_root_option( 'registration' );
 
            if ( 'blog' == $active_signup || 'all' == $active_signup ) {
                $blog_details = bp_core_validate_blog_signup( $_POST['signup_blog_url'], $_POST['signup_blog_title'] );
 
                // If there are errors with blog details, set them for display.
                if ( !empty( $blog_details['errors']->errors['blogname'] ) )
                    $bp->signup->errors['signup_blog_url'] = $blog_details['errors']->errors['blogname'][0];
 
                if ( !empty( $blog_details['errors']->errors['blog_title'] ) )
                    $bp->signup->errors['signup_blog_title'] = $blog_details['errors']->errors['blog_title'][0];
            }
        }
 
        /**
         * Fires after the validation of a new signup.
         *
         * @since BuddyPress 1.1.0
         */
        do_action( 'bp_signup_validate' );
 
        // Add any errors to the action for the field in the template for display.
        if ( !empty( $bp->signup->errors ) ) {
            foreach ( (array) $bp->signup->errors as $fieldname => $error_message ) {
                /**
                 * Filters the error message in the loop.
                 *
                 * @since BuddyPress 1.5.0
                 *
                 * @param string $value Error message wrapped in html.
                 */
                add_action( 'bp_' . $fieldname . '_errors', function() use ( $error_message ) {
                    echo apply_filters( 'bp_members_signup_error_message', "<div class=\"error\">" . $error_message . "</div>" );
                } );
            }
        } else {
            $bp->signup->step = 'save-details';
 
            // No errors! Let's register those deets.
            $active_signup = bp_core_get_root_option( 'registration' );
 
            if ( 'none' != $active_signup ) {
 
                // Make sure the profiles fields module is enabled.
                if ( bp_is_active( 'xprofile' ) ) {
                    // Let's compact any profile field info into usermeta.
                    $profile_field_ids = explode( ',', $_POST['signup_profile_field_ids'] );
 
                    /*
                     * Loop through the posted fields, formatting any
                     * datebox values, then add to usermeta.
                     */
                    foreach ( (array) $profile_field_ids as $field_id ) {
                        bp_xprofile_maybe_format_datebox_post_data( $field_id );
 
                        if ( !empty( $_POST['field_' . $field_id] ) )
                            $usermeta['field_' . $field_id] = $_POST['field_' . $field_id];
 
                        if ( !empty( $_POST['field_' . $field_id . '_visibility'] ) )
                            $usermeta['field_' . $field_id . '_visibility'] = $_POST['field_' . $field_id . '_visibility'];
                    }
 
                    // Store the profile field ID's in usermeta.
                    $usermeta['profile_field_ids'] = $_POST['signup_profile_field_ids'];
                }
 
                // Hash and store the password.
                $usermeta['password'] = wp_hash_password( $_POST['signup_password'] );
 
                // If the user decided to create a blog, save those details to usermeta.
                if ( 'blog' == $active_signup || 'all' == $active_signup )
                    $usermeta['public'] = ( isset( $_POST['signup_blog_privacy'] ) && 'public' == $_POST['signup_blog_privacy'] ) ? true : false;
 
                /**
                 * Filters the user meta used for signup.
                 *
                 * @since BuddyPress 1.1.0
                 *
                 * @param array $usermeta Array of user meta to add to signup.
                 */
                $usermeta = apply_filters( 'bp_signup_usermeta', $usermeta );
 
                // Finally, sign up the user and/or blog.
                if ( isset( $_POST['signup_with_blog'] ) && is_multisite() )
                    $wp_user_id = bp_core_signup_blog(
                        $blog_details['domain'],
                        $blog_details['path'],
                        $blog_details['blog_title'],
                        bp_get_signup_username_value(),
                        bp_get_signup_email_value(), $usermeta
                    );
                else
                    $wp_user_id = bp_core_signup_user(
                        bp_get_signup_username_value(),
                        $_POST['signup_password'],
                        bp_get_signup_email_value(),
                        $usermeta
                    );
 
                if ( is_wp_error( $wp_user_id ) ) {
                    $bp->signup->step = 'request-details';
                    bp_core_add_message( $wp_user_id->get_error_message(), 'error' );
                } else {
                    $bp->signup->step = 'completed-confirmation';
                }
            }
 
            /**
             * Fires after the completion of a new signup.
             *
             * @since BuddyPress 1.1.0
             */
            do_action( 'bp_complete_signup' );
        }
 
    }
 
    /**
     * Fires right before the loading of the Member registration screen template file.
     *
     * @since BuddyPress 1.5.0
     */
    do_action( 'bp_core_screen_signup' );
 
    /**
     * Filters the template to load for the Member registration page screen.
     *
     * @since BuddyPress 1.5.0
     *
     * @param string $value Path to the Member registration template to load.
     */
    bp_core_load_template( apply_filters( 'bp_core_template_register', array( 'register', 'registration/register' ) ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.1.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-options.php: bp_custom_register_page_url()

Register page URL.
bp-core/bp-core-options.php: bp_allow_custom_registration()

Allow custom registration.
bp-core/bp-core-options.php: bp_register_confirm_email()

Display email confirmation field in registrations.
bp-core/bp-core-options.php: bp_register_confirm_password()

Display password confirmation field in registrations.
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_nickname_field_id()

Get the field id of the nick name field, fallback to default fullname field
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_maybe_format_datebox_post_data()

Formats datebox field values passed through a POST request.
bp-xprofile/bp-xprofile-functions.php: xprofile_check_is_required_field()

Check if field is a required field.
bp-xprofile/bp-xprofile-functions.php: xprofile_validate_field()

Validate profile field.
bp-members/bp-members-functions.php: bp_core_validate_user_signup()

Validate a user name and email address when creating a new user.
bp-members/bp-members-functions.php: bp_core_validate_blog_signup()

Validate blog URL and title provided at signup.
bp-members/bp-members-functions.php: bp_core_signup_blog()

Create a blog and user based on data supplied at user registration.
bp-members/bp-members-functions.php: bp_core_signup_user()

Process data submitted at user registration and convert to a signup object.
bp-members/screens/register.php: bp_signup_pre_validate

Fires before the validation of a new signup.
bp-members/screens/register.php: bp_signup_validate

Fires after the validation of a new signup.
bp-members/screens/register.php: bp_members_signup_error_message

Filters the error message in the loop.
bp-members/screens/register.php: bp_signup_usermeta

Filters the user meta used for signup.
bp-members/screens/register.php: bp_complete_signup

Fires after the completion of a new signup.
bp-members/screens/register.php: bp_core_screen_signup

Fires right before the loading of the Member registration screen template file.
bp-members/screens/register.php: bp_core_template_register

Filters the template to load for the Member registration page screen.
bp-members/bp-members-template.php: bp_get_signup_allowed()

Is user signup allowed?
bp-members/bp-members-template.php: bp_get_signup_email_value()

Get the email address submitted during signup.
bp-members/bp-members-template.php: bp_get_signup_username_value()

Get the username submitted during signup.
bp-members/bp-members-template.php: bp_get_members_directory_permalink()

Return member directory permalink.
bp-core/bp-core-template.php: bp_is_active()

Check whether a given component (or feature of a component) is active.
bp-core/bp-core-template.php: bp_is_component_front_page()

Check if the specified BuddyPress component directory is set to be the front page.
bp-core/bp-core-template.php: bp_is_current_component()

Check to see whether the current page belongs to the specified component.
bp-core/bp-core-template.php: bp_get_root_domain()

Return the “root domain”, the URL of the BP root blog.
bp-core/bp-core-template.php: bp_current_action()

Return the name of the current action.
bp-core/bp-core-caps.php: bp_current_user_can()

Check whether the current user has a given capability.
bp-core/bp-core-functions.php: bp_verify_nonce_request()

Makes sure the user requested an action from another page on this site.
bp-core/bp-core-functions.php: bp_update_is_directory()

Set the “is_directory” global.
bp-core/bp-core-functions.php: bp_core_add_message()

Add a feedback (error/success) message to the WP cookie so it can be displayed after the page reloads.
bp-core/bp-core-functions.php: bp_core_redirect()

Perform a status-safe wp_redirect() that is compatible with BP’s URI parser.
bp-members/screens/register.php: bp_loggedin_register_page_redirect_to

Filters the URL to redirect logged in users to when visiting registration page.
bp-core/bp-core-catchuri.php: bp_core_load_template()

Load a specific template file with fallback support.
bp-core/bp-core-options.php: bp_core_get_root_option()

Get a root option.
Show 32 more uses Hide more uses

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.