From 651be4d15718c4caa6644245668451c293188961 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sat, 28 Sep 2013 23:41:07 +0000 Subject: [PATCH] Inline documentation for hooks in wp-signup.php. Props kpdesign, miyauchi. Fixes #25381. git-svn-id: https://develop.svn.wordpress.org/trunk@25645 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-signup.php | 167 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 153 insertions(+), 14 deletions(-) diff --git a/src/wp-signup.php b/src/wp-signup.php index 7851e1a49a..ff8faa4cfc 100644 --- a/src/wp-signup.php +++ b/src/wp-signup.php @@ -18,6 +18,11 @@ if ( is_array( get_site_option( 'illegal_names' )) && isset( $_GET[ 'new' ] ) && * @since MU */ function do_signup_header() { + /** + * Fires within the 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' ); ?>
@@ -128,7 +138,14 @@ function show_blog_form($blogname = '', $blog_title = '', $errors = '') {
get_error_message('generic') ) { echo '

' . $errmsg . '

'; } + /** + * 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 = '') { 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, $ http://%2$s is your new site. Log in as “%4$s” using your existing password.' ), $domain.$path, $domain.$path, "http://" . $domain.$path . "wp-login.php", $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) {

%s and click the link given.' ), $user_email ); ?>

$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

- +