ClassicPress logo
Skip to content
Filter by type:

Browse:

  • Home
  • Functions
  • signup_blog()

signup_blog( string $user_name = '', string $user_email = '', string $blogname = '', string $blog_title = '', WP_Error|string $errors = '' )

Shows a form for a user or visitor to sign up for a new site.


Parameters

$user_name

(Optional) The username.

Default value: ''

$user_email

(Optional) The user's email address.

Default value: ''

$blogname

(Optional) The site name.

Default value: ''

$blog_title

(Optional) The site title.

Default value: ''

$errors

(Optional) A WP_Error object containing existing errors. Defaults to empty string.

Default value: ''


Source

File: wp-signup.php

function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_title = '', $errors = '') {
	if ( !is_wp_error($errors) )
		$errors = new WP_Error();

	$signup_blog_defaults = array(
		'user_name'  => $user_name,
		'user_email' => $user_email,
		'blogname'   => $blogname,
		'blog_title' => $blog_title,
		'errors'     => $errors
	);

	/**
	 * Filters the default site creation variables for the site sign-up form.
	 *
	 * @since WP-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 WP_Error $errors     A WP_Error object with 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'];
	$blog_title = $filtered_results['blog_title'];
	$errors = $filtered_results['errors'];

	if ( empty($blogname) )
		$blogname = $user_name;
	?>
	<form id="setupform" method="post" action="wp-signup.php">
		<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
		/** 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
}

Expand Source Code View on GitHub


Related

Uses

Uses
Uses Description
wp-signup.php: signup_blog_init

Filters the default site creation variables for the site sign-up form.

wp-signup.php: show_blog_form()

Generates and displays the Sign-up and Create Site forms.

wp-signup.php: signup_hidden_fields

Hidden sign-up form fields output when creating another site or user.

wp-includes/plugin.php: do_action()

Calls the callback functions that have been added to an action hook.

wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Used By

Used By
Used By Description
wp-signup.php: validate_user_signup()

Validates the new user sign-up.

wp-signup.php: validate_blog_signup()

Validates new site signup.


Changelog

Changelog
Version Description
MU (3.0.0) Introduced. MU (3.0.0)
ClassicPress Documentation • Made with ClassicPress
Privacy Policy