W3cubDocs

/WordPress

wp_install( string $blog_title, string $user_name, string $user_email, bool $public, string $deprecated = '', string $user_password = '', string $language = '' )

Installs the site.

Description

Runs the required functions to set up and populate the database, including primary admin user and initial options.

Parameters

$blog_title

(string) (Required) Site title.

$user_name

(string) (Required) User's username.

$user_email

(string) (Required) User's email.

$public

(bool) (Required) Whether site is public.

$deprecated

(string) (Optional) Not used.

Default value: ''

$user_password

(string) (Optional) User's chosen password. Default empty (random password).

Default value: ''

$language

(string) (Optional) Language chosen.

Default value: ''

Return

(array) Data for the newly installed site.

  • 'url'
    (string) The URL of the site.
  • 'user_id'
    (int) The ID of the site owner.
  • 'password'
    (string) The password of the site owner, if their user account didn't already exist.
  • 'password_message'
    (string) The explanatory message regarding the password.

Source

File: wp-admin/includes/upgrade.php 

function wp_install( $blog_title, $user_name, $user_email, $public, $deprecated = '', $user_password = '', $language = '' ) {
		if ( ! empty( $deprecated ) ) {
			_deprecated_argument( __FUNCTION__, '2.6.0' );
		}

		wp_check_mysql_version();
		wp_cache_flush();
		make_db_current_silent();
		populate_options();
		populate_roles();

		update_option( 'blogname', $blog_title );
		update_option( 'admin_email', $user_email );
		update_option( 'blog_public', $public );

		// Freshness of site - in the future, this could get more specific about actions taken, perhaps.
		update_option( 'fresh_site', 1 );

		if ( $language ) {
			update_option( 'WPLANG', $language );
		}

		$guessurl = wp_guess_url();

		update_option( 'siteurl', $guessurl );

		// If not a public site, don't ping.
		if ( ! $public ) {
			update_option( 'default_pingback_flag', 0 );
		}

		/*
		 * Create default user. If the user already exists, the user tables are
		 * being shared among sites. Just set the role in that case.
		 */
		$user_id        = username_exists( $user_name );
		$user_password  = trim( $user_password );
		$email_password = false;
		$user_created   = false;

		if ( ! $user_id && empty( $user_password ) ) {
			$user_password = wp_generate_password( 12, false );
			$message       = __( '<strong><em>Note that password</em></strong> carefully! It is a <em>random</em> password that was generated just for you.' );
			$user_id       = wp_create_user( $user_name, $user_password, $user_email );
			update_user_option( $user_id, 'default_password_nag', true, true );
			$email_password = true;
			$user_created   = true;
		} elseif ( ! $user_id ) {
			// Password has been provided.
			$message      = '<em>' . __( 'Your chosen password.' ) . '</em>';
			$user_id      = wp_create_user( $user_name, $user_password, $user_email );
			$user_created = true;
		} else {
			$message = __( 'User already exists. Password inherited.' );
		}

		$user = new WP_User( $user_id );
		$user->set_role( 'administrator' );

		if ( $user_created ) {
			$user->user_url = $guessurl;
			wp_update_user( $user );
		}

		wp_install_defaults( $user_id );

		wp_install_maybe_enable_pretty_permalinks();

		flush_rewrite_rules();

		wp_new_blog_notification( $blog_title, $guessurl, $user_id, ( $email_password ? $user_password : __( 'The password you chose during installation.' ) ) );

		wp_cache_flush();

		/**
		 * Fires after a site is fully installed.
		 *
		 * @since 3.9.0
		 *
		 * @param WP_User $user The site owner.
		 */
		do_action( 'wp_install', $user );

		return array(
			'url'              => $guessurl,
			'user_id'          => $user_id,
			'password'         => $user_password,
			'password_message' => $message,
		);
	}

Uses

Uses Description
wp-admin/includes/upgrade.php: wp_install_maybe_enable_pretty_permalinks()

Maybe enable pretty permalinks on installation.
wp-admin/includes/schema.php: populate_roles()

Execute WordPress role creation for the various WordPress versions.
wp-admin/includes/schema.php: populate_options()

Create WordPress options and set the default values.
wp-admin/includes/upgrade.php: wp_check_mysql_version()

Checks the version of the installed MySQL binary.
wp-admin/includes/upgrade.php: make_db_current_silent()

Updates the database tables to a new schema, but without displaying results.
wp-admin/includes/upgrade.php: wp_install_defaults()

Creates the initial content for a newly-installed site.
wp-admin/includes/upgrade.php: wp_new_blog_notification()

Notifies the site admin that the setup is complete.
wp-admin/includes/upgrade.php: wp_install

Fires after a site is fully installed.
wp-includes/class-wp-user.php: WP_User::__construct()

Constructor.
wp-includes/cache.php: wp_cache_flush()

Removes all cache items.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/pluggable.php: wp_generate_password()

Generates a random password drawn from the defined set of characters.
wp-includes/functions.php: wp_guess_url()

Guess the URL for the site.
wp-includes/functions.php: _deprecated_argument()

Mark a function argument as deprecated and inform when it has been used.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/option.php: update_option()

Updates the value of an option that was already added.
wp-includes/user.php: wp_create_user()

A simpler way of inserting a user into the database.
wp-includes/user.php: wp_update_user()

Update a user in the database.
wp-includes/user.php: username_exists()

Determines whether the given username exists.
wp-includes/user.php: update_user_option()

Update user option with global blog capability.
wp-includes/rewrite.php: flush_rewrite_rules()

Remove rewrite rules and then recreate rewrite rules.

Changelog

Version Description
2.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_install