Wordpress 3.7
[autoinstalls/wordpress.git] / wp-signup.php
index 7d35d8659fd1e7fc45bd465cb9859f50a380ea1e..0ecee1e1d685c27be054c10f05420aa8e657f370 100644 (file)
@@ -5,14 +5,24 @@ require( dirname(__FILE__) . '/wp-load.php' );
 
 add_action( 'wp_head', 'wp_no_robots' );
 
-require( './wp-blog-header.php' );
+require( dirname( __FILE__ ) . '/wp-blog-header.php' );
 
 if ( is_array( get_site_option( 'illegal_names' )) && isset( $_GET[ 'new' ] ) && in_array( $_GET[ 'new' ], get_site_option( 'illegal_names' ) ) == true ) {
        wp_redirect( network_home_url() );
        die();
 }
 
+/**
+ * Prints signup_header via wp_head
+ *
+ * @since MU
+ */
 function do_signup_header() {
+       /**
+        * Fires within the <head> section of the site sign-up screen.
+        *
+        * @since 3.0.0
+        */
        do_action( 'signup_header' );
 }
 add_action( 'wp_head', 'do_signup_header' );
@@ -30,6 +40,11 @@ if ( !is_main_site() ) {
 // Fix for page title
 $wp_query->is_404 = false;
 
+/**
+ * Prints styles for front-end Multisite signup pages
+ *
+ * @since MU
+ */
 function wpmu_signup_stylesheet() {
        ?>
        <style type="text/css">
@@ -53,11 +68,25 @@ function wpmu_signup_stylesheet() {
 add_action( 'wp_head', 'wpmu_signup_stylesheet' );
 get_header();
 
+/**
+ * Fires before the site sign-up form.
+ *
+ * @since 3.0.0
+ */
 do_action( 'before_signup_form' );
 ?>
 <div id="content" class="widecolumn">
 <div class="mu_register">
 <?php
+/**
+ * Generates and displays the Signup and Create Site forms
+ *
+ * @since MU
+ *
+ * @param string $blogname The new site name
+ * @param string $blog_title The new site title
+ * @param array $errors
+ */
 function show_blog_form($blogname = '', $blog_title = '', $errors = '') {
        global $current_site;
        // Blog name
@@ -109,9 +138,25 @@ function show_blog_form($blogname = '', $blog_title = '', $errors = '') {
        </div>
 
        <?php
-       do_action('signup_blogform', $errors);
+       /**
+        * Fires after the site sign-up form.
+        *
+        * @since 3.0.0
+        *
+        * @param array $errors An array possibly containing 'blogname' or 'blog_title' errors.
+        */
+       do_action( 'signup_blogform', $errors );
 }
 
+/**
+ * Validate the new site signup
+ *
+ * @since MU
+ *
+ * @uses wp_get_current_user() to retrieve the current user
+ * @uses wpmu_validate_blog_signup() to validate new site signup for the current user
+ * @return array Contains the new site data and error messages.
+ */
 function validate_blog_form() {
        $user = '';
        if ( is_user_logged_in() )
@@ -120,6 +165,15 @@ function validate_blog_form() {
        return wpmu_validate_blog_signup($_POST['blogname'], $_POST['blog_title'], $user);
 }
 
+/**
+ * Display user registration form
+ *
+ * @since MU
+ *
+ * @param string $user_name The entered username
+ * @param string $user_email The entered email address
+ * @param array $errors
+ */
 function show_user_form($user_name = '', $user_email = '', $errors = '') {
        // User name
        echo '<label for="user_name">' . __('Username:') . '</label>';
@@ -139,13 +193,38 @@ function show_user_form($user_name = '', $user_email = '', $errors = '') {
        if ( $errmsg = $errors->get_error_message('generic') ) {
                echo '<p class="error">' . $errmsg . '</p>';
        }
+       /**
+        * Fires at the end of the user registration form on the site sign-up form.
+        *
+        * @since 3.0.0
+        *
+        * @param array $errors An array possibly containing 'user_name' or 'user_email' errors.
+        */
        do_action( 'signup_extra_fields', $errors );
 }
 
+/**
+ * Validate user signup name and email
+ *
+ * @since MU
+ *
+ * @uses wpmu_validate_user_signup() to retrieve an array of user data
+ * @return array Contains username, email, and error messages.
+ */
 function validate_user_form() {
        return wpmu_validate_user_signup($_POST['user_name'], $_POST['user_email']);
 }
 
+/**
+ * Allow returning users to sign up for another site
+ *
+ * @since MU
+ *
+ * @uses wp_get_current_user() to get the current user
+ * @param string $blogname The new site name
+ * @param string $blog_title The new blog title
+ * @param array $errors
+ */
 function signup_another_blog($blogname = '', $blog_title = '', $errors = '') {
        global $current_site;
        $current_user = wp_get_current_user();
@@ -154,8 +233,27 @@ function signup_another_blog($blogname = '', $blog_title = '', $errors = '') {
                $errors = new WP_Error();
        }
 
-       // allow definition of default variables
-       $filtered_results = apply_filters('signup_another_blog_init', array('blogname' => $blogname, 'blog_title' => $blog_title, 'errors' => $errors ));
+       $signup_defaults = array(
+               'blogname'   => $blogname,
+               'blog_title' => $blog_title,
+               'errors'     => $errors
+       );
+
+       /**
+        * Filter the default site sign-up variables.
+        *
+        * @since 3.0.0
+        *
+        * @param array $signup_defaults {
+        *     An array of default site sign-up variables.
+        *
+        *     @type string $blogname   The site blogname.
+        *     @type string $blog_title The site title.
+        *     @type array  $errors     An array possibly containing 'blogname' or 'blog_title' errors.
+        * }
+        */
+       $filtered_results = apply_filters( 'signup_another_blog_init', $signup_defaults );
+
        $blogname = $filtered_results['blogname'];
        $blog_title = $filtered_results['blog_title'];
        $errors = $filtered_results['errors'];
@@ -184,13 +282,33 @@ function signup_another_blog($blogname = '', $blog_title = '', $errors = '') {
        <p><?php _e( 'If you&#8217;re not going to use a great site domain, leave it for a new user. Now have at it!' ) ?></p>
        <form id="setupform" method="post" action="wp-signup.php">
                <input type="hidden" name="stage" value="gimmeanotherblog" />
-               <?php do_action( 'signup_hidden_fields' ); ?>
+               <?php
+               /**
+                * Hidden sign-up form fields output when creating another site or user.
+                *
+                * @since MU
+                *
+                * @param string $context A string describing the steps of the sign-up process. The value can be
+                *                        'create-another-site', 'validate-user', or 'validate-site'.
+                */
+               do_action( 'signup_hidden_fields', 'create-another-site' );
+               ?>
                <?php show_blog_form($blogname, $blog_title, $errors); ?>
                <p class="submit"><input type="submit" name="submit" class="submit" value="<?php esc_attr_e( 'Create Site' ) ?>" /></p>
        </form>
        <?php
 }
 
+/**
+ * Validate a new blog signup
+ *
+ * @since MU
+ *
+ * @uses wp_get_current_user() to retrieve the current user
+ * @uses wpmu_create_blog() to add a new site
+ * @uses confirm_another_blog_signup() to confirm the user's new site signup
+ * @return bool True if blog signup was validated, false if error
+ */
 function validate_another_blog_signup() {
        global $wpdb, $blogname, $blog_title, $errors, $domain, $path;
        $current_user = wp_get_current_user();
@@ -206,7 +324,33 @@ function validate_another_blog_signup() {
        }
 
        $public = (int) $_POST['blog_public'];
-       $meta = apply_filters( 'signup_create_blog_meta', array( 'lang_id' => 1, 'public' => $public ) ); // deprecated
+
+       $blog_meta_defaults = array(
+               'lang_id' => 1,
+               'public'  => $public
+       );
+
+       /**
+        * Filter the new site meta variables.
+        *
+        * @since MU
+        * @deprecated 3.0.0 Use the 'add_signup_meta' filter instead.
+        *
+        * @param array $blog_meta_defaults An array of default blog meta variables.
+        */
+       $meta = apply_filters( 'signup_create_blog_meta', $blog_meta_defaults );
+       /**
+        * Filter the new default site meta variables.
+        *
+        * @since 3.0.0
+        *
+        * @param array $meta {
+        *     An array of default site meta variables.
+        *
+        *     @type int $lang_id     The language ID.
+        *     @type int $blog_public Whether search engines should be discouraged from indexing the site. 1 for true, 0 for false.
+        * }
+        */
        $meta = apply_filters( 'add_signup_meta', $meta );
 
        wpmu_create_blog( $domain, $path, $blog_title, $current_user->ID, $meta, $wpdb->siteid );
@@ -214,16 +358,43 @@ function validate_another_blog_signup() {
        return true;
 }
 
-function confirm_another_blog_signup($domain, $path, $blog_title, $user_name, $user_email = '', $meta = '') {
+/**
+ * Confirm a new site signup
+ *
+ * @since MU
+ *
+ * @param string $domain The domain URL
+ * @param string $path The site root path
+ * @param string $user_name The username
+ * @param string $user_email The user's email address
+ * @param array $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup()
+ */
+function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = array() ) {
        ?>
        <h2><?php printf( __( 'The site %s is yours.' ), "<a href='http://{$domain}{$path}'>{$blog_title}</a>" ) ?></h2>
        <p>
                <?php printf( __( '<a href="http://%1$s">http://%2$s</a> is your new site. <a href="%3$s">Log in</a> as &#8220;%4$s&#8221; using your existing password.' ), $domain.$path, $domain.$path, "http://" . $domain.$path . "wp-login.php", $user_name ) ?>
        </p>
        <?php
+       /**
+        * Fires when the site or user sign-up process is complete.
+        *
+        * @since 3.0.0
+        */
        do_action( 'signup_finished' );
 }
 
+/**
+ * Setup the new user signup process
+ *
+ * @since MU
+ *
+ * @uses apply_filters() filter $filtered_results
+ * @uses show_user_form() to display the user registration form
+ * @param string $user_name The username
+ * @param string $user_email The user's email
+ * @param array $errors
+ */
 function signup_user($user_name = '', $user_email = '', $errors = '') {
        global $current_site, $active_signup;
 
@@ -232,8 +403,26 @@ function signup_user($user_name = '', $user_email = '', $errors = '') {
 
        $signup_for = isset( $_POST[ 'signup_for' ] ) ? esc_html( $_POST[ 'signup_for' ] ) : 'blog';
 
-       // allow definition of default variables
-       $filtered_results = apply_filters('signup_user_init', array('user_name' => $user_name, 'user_email' => $user_email, 'errors' => $errors ));
+       $signup_user_defaults = array(
+               'user_name'  => $user_name,
+               'user_email' => $user_email,
+               'errors'     => $errors,
+       );
+
+       /**
+        * Filter the default user variables used on the user sign-up form.
+        *
+        * @since 3.0.0
+        *
+        * @param array $signup_user_defaults {
+        *     An array of default user variables.
+        *
+        *     @type string $user_name  The user username.
+        *     @type string $user_email The user email address.
+        *     @type array  $errors     An array of possible errors relevant to the sign-up user.
+        * }
+        */
+       $filtered_results = apply_filters( 'signup_user_init', $signup_user_defaults );
        $user_name = $filtered_results['user_name'];
        $user_email = $filtered_results['user_email'];
        $errors = $filtered_results['errors'];
@@ -243,7 +432,10 @@ function signup_user($user_name = '', $user_email = '', $errors = '') {
        <h2><?php printf( __( 'Get your own %s account in seconds' ), $current_site->site_name ) ?></h2>
        <form id="setupform" method="post" action="wp-signup.php">
                <input type="hidden" name="stage" value="validate-user-signup" />
-               <?php do_action( 'signup_hidden_fields' ); ?>
+               <?php
+               /** This action is documented in wp-signup.php */
+               do_action( 'signup_hidden_fields', 'validate-user' );
+               ?>
                <?php show_user_form($user_name, $user_email, $errors); ?>
 
                <p>
@@ -265,6 +457,16 @@ function signup_user($user_name = '', $user_email = '', $errors = '') {
        <?php
 }
 
+/**
+ * Validate the new user signup
+ *
+ * @since MU
+ *
+ * @uses validate_user_form() to retrieve an array of the user data
+ * @uses wpmu_signup_user() to signup the new user
+ * @uses confirm_user_signup() to confirm the new user signup
+ * @return bool True if new user signup was validated, false if error
+ */
 function validate_user_signup() {
        $result = validate_user_form();
        extract($result);
@@ -279,12 +481,21 @@ function validate_user_signup() {
                return false;
        }
 
-       wpmu_signup_user($user_name, $user_email, apply_filters( 'add_signup_meta', array() ) );
+       /** This filter is documented in wp-signup.php */
+       wpmu_signup_user( $user_name, $user_email, apply_filters( 'add_signup_meta', array() ) );
 
        confirm_user_signup($user_name, $user_email);
        return true;
 }
 
+/**
+ * New user signup confirmation
+ *
+ * @since MU
+ *
+ * @param string $user_name The username
+ * @param string $user_email The user's email address
+ */
 function confirm_user_signup($user_name, $user_email) {
        ?>
        <h2><?php printf( __( '%s is your new username' ), $user_name) ?></h2>
@@ -292,15 +503,52 @@ function confirm_user_signup($user_name, $user_email) {
        <p><?php printf( __( 'Check your inbox at <strong>%s</strong> and click the link given.' ), $user_email ); ?></p>
        <p><?php _e( 'If you do not activate your username within two days, you will have to sign up again.' ); ?></p>
        <?php
+       /** This action is documented in wp-signup.php */
        do_action( 'signup_finished' );
 }
 
+/**
+ * Setup the new site signup
+ *
+ * @since MU
+ *
+ * @uses apply_filters() to filter $filtered_results
+ * @uses show_blog_form() to display the blog signup form
+ * @param string $user_name The username
+ * @param string $user_email The user's email address
+ * @param string $blogname The site name
+ * @param string $blog_title The site title
+ * @param array $errors
+ */
 function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_title = '', $errors = '') {
        if ( !is_wp_error($errors) )
                $errors = new WP_Error();
 
-       // allow definition of default variables
-       $filtered_results = apply_filters('signup_blog_init', array('user_name' => $user_name, 'user_email' => $user_email, 'blogname' => $blogname, 'blog_title' => $blog_title, 'errors' => $errors ));
+       $signup_blog_defaults = array(
+               'user_name'  => $user_name,
+               'user_email' => $user_email,
+               'blogname'   => $blogname,
+               'blog_title' => $blog_title,
+               'errors'     => $errors
+       );
+
+       /**
+        * Filter the default site creation variables for the site sign-up form.
+        *
+        * @since 3.0.0
+        *
+        * @param array $signup_blog_defaults {
+        *     An array of default site creation variables.
+        *
+        *     @type string $user_name  The user username.
+        *     @type string $user_email The user email address.
+        *     @type string $blogname   The blogname.
+        *     @type string $blog_title The title of the site.
+        *     @type array  $errors     An array of possible errors relevant to new site creation variables.
+        * }
+        */
+       $filtered_results = apply_filters( 'signup_blog_init', $signup_blog_defaults );
+
        $user_name = $filtered_results['user_name'];
        $user_email = $filtered_results['user_email'];
        $blogname = $filtered_results['blogname'];
@@ -314,13 +562,28 @@ function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_ti
                <input type="hidden" name="stage" value="validate-blog-signup" />
                <input type="hidden" name="user_name" value="<?php echo esc_attr($user_name) ?>" />
                <input type="hidden" name="user_email" value="<?php echo esc_attr($user_email) ?>" />
-               <?php do_action( 'signup_hidden_fields' ); ?>
+               <?php
+               /** This action is documented in wp-signup.php */
+               do_action( 'signup_hidden_fields', 'validate-site' );
+               ?>
                <?php show_blog_form($blogname, $blog_title, $errors); ?>
                <p class="submit"><input type="submit" name="submit" class="submit" value="<?php esc_attr_e('Signup') ?>" /></p>
        </form>
        <?php
 }
 
+/**
+ * Validate new site signup
+ *
+ * @since MU
+ *
+ * @uses wpmu_validate_user_signup() to retrieve an array of the new user data and errors
+ * @uses wpmu_validate_blog_signup() to retrieve an array of the new site data and errors
+ * @uses apply_filters() to make signup $meta filterable
+ * @uses signup_user() to signup a new user
+ * @uses signup_blog() to signup a the new user to a new site
+ * @return bool True if the site signup was validated, false if error
+ */
 function validate_blog_signup() {
        // Re-validate user info.
        $result = wpmu_validate_user_signup($_POST['user_name'], $_POST['user_email']);
@@ -341,6 +604,8 @@ function validate_blog_signup() {
 
        $public = (int) $_POST['blog_public'];
        $meta = array ('lang_id' => 1, 'public' => $public);
+
+       /** This filter is documented in wp-signup.php */
        $meta = apply_filters( 'add_signup_meta', $meta );
 
        wpmu_signup_blog($domain, $path, $blog_title, $user_name, $user_email, $meta);
@@ -348,7 +613,19 @@ function validate_blog_signup() {
        return true;
 }
 
-function confirm_blog_signup($domain, $path, $blog_title, $user_name = '', $user_email = '', $meta) {
+/**
+ * New site signup confirmation
+ *
+ * @since MU
+ *
+ * @param string $domain The domain URL
+ * @param string $path The site root path
+ * @param string $blog_title The new site title
+ * @param string $user_name The user's username
+ * @param string $user_email The user's email address
+ * @param array $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup()
+ */
+function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $user_email = '', $meta = array() ) {
        ?>
        <h2><?php printf( __( 'Congratulations! Your new site, %s, is almost ready.' ), "<a href='http://{$domain}{$path}'>{$blog_title}</a>" ) ?></h2>
 
@@ -361,19 +638,25 @@ function confirm_blog_signup($domain, $path, $blog_title, $user_name = '', $user
                <ul id="noemail-tips">
                        <li><p><strong><?php _e( 'Wait a little longer. Sometimes delivery of email can be delayed by processes outside of our control.' ) ?></strong></p></li>
                        <li><p><?php _e( 'Check the junk or spam folder of your email client. Sometime emails wind up there by mistake.' ) ?></p></li>
-                       <li><?php printf( __( 'Have you entered your email correctly?  You have entered %s, if it&#8217;s incorrect, you will not receive your email.' ), $user_email ) ?></li>
+                       <li><?php printf( __( 'Have you entered your email correctly? You have entered %s, if it&#8217;s incorrect, you will not receive your email.' ), $user_email ) ?></li>
                </ul>
        </p>
        <?php
+       /** This action is documented in wp-signup.php */
        do_action( 'signup_finished' );
 }
 
 // Main
-$active_signup = get_site_option( 'registration' );
-if ( !$active_signup )
-       $active_signup = 'all';
-
-$active_signup = apply_filters( 'wpmu_active_signup', $active_signup ); // return "all", "none", "blog" or "user"
+$active_signup = get_site_option( 'registration', 'none' );
+/**
+ * Filter the type of site sign-up.
+ *
+ * @since 3.0.0
+ *
+ * @param string $active_signup String that returns registration type. The value can be
+ *                              'all', 'none', 'blog', or 'user'.
+ */
+$active_signup = apply_filters( 'wpmu_active_signup', $active_signup );
 
 // Make the signup type translatable.
 $i18n_signup['all'] = _x('all', 'Multisite active signup type');
@@ -413,7 +696,12 @@ if ( $active_signup == 'none' ) {
                case 'default':
                default :
                        $user_email = isset( $_POST[ 'user_email' ] ) ? $_POST[ 'user_email' ] : '';
-                       do_action( 'preprocess_signup_form' ); // populate the form from invites, elsewhere?
+                       /**
+                        * Fires when the site sign-up form is sent.
+                        *
+                        * @since 3.0.0
+                        */
+                       do_action( 'preprocess_signup_form' );
                        if ( is_user_logged_in() && ( $active_signup == 'all' || $active_signup == 'blog' ) )
                                signup_another_blog($newblogname);
                        elseif ( is_user_logged_in() == false && ( $active_signup == 'all' || $active_signup == 'user' ) )
@@ -427,9 +715,9 @@ if ( $active_signup == 'none' ) {
                                $newblog = get_blogaddress_by_name( $newblogname );
 
                                if ( $active_signup == 'blog' || $active_signup == 'all' )
-                                       printf( __( '<p><em>The site you were looking for, <strong>%s</strong> does not exist, but you can create it now!</em></p>' ), $newblog );
+                                       printf( '<p><em>' . __( 'The site you were looking for, <strong>%s</strong>, does not exist, but you can create it now!' ) . '</em></p>', $newblog );
                                else
-                                       printf( __( '<p><em>The site you were looking for, <strong>%s</strong>, does not exist.</em></p>' ), $newblog );
+                                       printf( '<p><em>' . __( 'The site you were looking for, <strong>%s</strong>, does not exist.' ) . '</em></p>', $newblog );
                        }
                        break;
        }
@@ -437,6 +725,12 @@ if ( $active_signup == 'none' ) {
 ?>
 </div>
 </div>
-<?php do_action( 'after_signup_form' ); ?>
+<?php
+/**
+ * Fires after the sign-up forms, before wp_footer.
+ *
+ * @since 3.0.0
+ */
+do_action( 'after_signup_form' ); ?>
 
 <?php get_footer(); ?>