Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-26 06:13:07 +02:00
Code Issues Projects Releases Wiki Activity

Inline documentation for hooks in wp-signup.php.

Browse Source 
Props kpdesign, miyauchi.

Fixes #25381.

Built from https://develop.svn.wordpress.org/trunk@25645


git-svn-id: http://core.svn.wordpress.org/trunk@25562 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-09-28 23:42:09 +00:00
parent 190913aaa7
commit 4128a1a170
1 changed files with 153 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
wp-signup.php
View File

@ -18,6 +18,11 @@ if ( is_array( get_site_option( 'illegal_names' )) && isset( $_GET[ 'new' ] ) &&
* @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' );
@ -63,6 +68,11 @@ 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">
@ -128,7 +138,14 @@ 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 );
}
/**
@ -176,6 +193,13 @@ 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 );
}
@ -209,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'];
@ -241,11 +284,11 @@ function signup_another_blog($blogname = '', $blog_title = '', $errors = '') {
<input type="hidden" name="stage" value="gimmeanotherblog" />
<?php
/**
* Hidden signup form fields output for creating another site.
* Hidden sign-up form fields output when creating another site or user.
*
* @since MU
*
* @param string $context A string describing the step of the signup process. the value can be
* @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' );
@ -281,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 );
@ -307,6 +376,11 @@ function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $
<?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' );
}
@ -329,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'];
@ -389,7 +481,8 @@ function validate_user_signup() {
return false;
}
wpmu_signup_user($user_name, $user_email, apply_filters( 'add_signup_meta', array() ) );
//duplicate_hook
wpmu_signup_user( $user_name, $user_email, apply_filters( 'add_signup_meta', array() ) );
confirm_user_signup($user_name, $user_email);
return true;
@ -410,6 +503,7 @@ 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
//duplicate_hook
do_action( 'signup_finished' );
}
@ -430,8 +524,31 @@ function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_ti
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'];
@ -487,6 +604,8 @@ function validate_blog_signup() {
$public = (int) $_POST['blog_public'];
$meta = array ('lang_id' => 1, 'public' => $public);
//duplicate_hook
$meta = apply_filters( 'add_signup_meta', $meta );
wpmu_signup_blog($domain, $path, $blog_title, $user_name, $user_email, $meta);
@ -523,12 +642,21 @@ function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $use
</ul>
</p>
<?php
//duplicate_hook
do_action( 'signup_finished' );
}
// Main
$active_signup = get_site_option( 'registration', 'none' );
$active_signup = apply_filters( 'wpmu_active_signup', $active_signup ); // return "all", "none", "blog" or "user"
/**
* 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');
@ -568,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' ) )
@ -592,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(); ?>