wp_install( string $blog_title, string $user_name, string $user_email, bool $is_public, string $deprecated = '', string $user_password = '', string $language = '' ): array

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$blog_titlestring

Site title.

$user_namestring

User's username.

$user_emailstring

User's email.

$is_publicbool

Whether the site is public.

$deprecatedstringoptional

Not used.Default: ''

$user_passwordstringoptional

User's chosen password. Default empty (random password).Default: ''

$languagestringoptional

Language chosen. Default empty.Default: ''

Return value

array

Data for the newly installed site.

• $urlstring

  The URL of the site.

• $user_idint

  The ID of the site owner.

• $passwordstring

  The password of the site owner, if their user account didn't already exist.

• $password_messagestring

  The explanatory message regarding the password.

Performance profile

How much work a call to wp_install() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Reaches an outbound HTTP request via wp_remote_get().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

131–171

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 191.

Plugin surface

1 hook

Third-party callbacks on 'wp_install' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• cacheobject cachewp_cache_flush()called directly
• optionoption read or writeupdate_option()called directly
• hookthird-party callbacksdo_action()called directly
• serializeserialisationmaybe_serialize()one call below wp_install()
• querycontent queryget_user_by()one call below wp_install()
• mailsends mailwp_mail()one call below wp_install()
• httpoutbound HTTP requestwp_remote_get()one call below wp_install()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 96 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_install() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_install() runs, in this order:

1. 1
   do_action( wp_install )actionline 143 (+96 into the body)

   Fires after a site is fully installed.

Uses · 22

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• wp_check_mysql_version()Checks the version of the installed MySQL binary.
• wp_cache_flush()Removes all cache items.
• make_db_current_silent()Updates the database tables to a new schema, but without displaying results.
• wp_unschedule_hook()Unschedules all events attached to the hook.
• wp_schedule_event()Schedules a recurring event.
• populate_options()Create WordPress options and set the default values.
• populate_roles()Execute WordPress role creation for the various WordPress versions.
• update_option()Updates the value of an option that was already added.
• wp_guess_url()Guesses the URL for the site.
• username_exists()Determines whether the given username exists.
• wp_generate_password()Generates a random password drawn from the defined set of characters.

Source code

View on Trac ↗View on GitHub ↗

47	function wp_install( $blog_title, $user_name, $user_email, $is_public, $deprecated = '', $user_password = '', $language = '' ) {48		if ( ! empty( $deprecated ) ) {49			_deprecated_argument( __FUNCTION__, '2.6.0' );50		}51 52		wp_check_mysql_version();53		wp_cache_flush();54		make_db_current_silent();55 56		/*57		 * Ensure update checks are delayed after installation.58		 *59		 * This prevents users being presented with a maintenance mode screen60		 * immediately after installation.61		 */62		wp_unschedule_hook( 'wp_version_check' );63		wp_unschedule_hook( 'wp_update_plugins' );64		wp_unschedule_hook( 'wp_update_themes' );65 66		wp_schedule_event( time() + HOUR_IN_SECONDS, 'twicedaily', 'wp_version_check' );67		wp_schedule_event( time() + ( 1.5 * HOUR_IN_SECONDS ), 'twicedaily', 'wp_update_plugins' );68		wp_schedule_event( time() + ( 2 * HOUR_IN_SECONDS ), 'twicedaily', 'wp_update_themes' );69 70		populate_options();71		populate_roles();72 73		update_option( 'blogname', $blog_title );74		update_option( 'admin_email', $user_email );75		update_option( 'blog_public', $is_public );76 77		// Freshness of site - in the future, this could get more specific about actions taken, perhaps.78		update_option( 'fresh_site', 1, false );79 80		if ( $language ) {81			update_option( 'WPLANG', $language );82		}83 84		$guessurl = wp_guess_url();85 86		update_option( 'siteurl', $guessurl );87 88		// If not a public site, don't ping.89		if ( ! $is_public ) {90			update_option( 'default_pingback_flag', 0 );91		}92 93		/*94		 * Create default user. If the user already exists, the user tables are95		 * being shared among sites. Just set the role in that case.96		 */97		$user_id        = username_exists( $user_name );98		$user_password  = trim( $user_password );99		$email_password = false;100		$user_created   = false;101 102		if ( ! $user_id && empty( $user_password ) ) {103			$user_password = wp_generate_password( 12, false );104			$message       = __( '<strong><em>Note that password</em></strong> carefully! It is a <em>random</em> password that was generated just for you.' );105			$user_id       = wp_create_user( $user_name, $user_password, $user_email );106			update_user_meta( $user_id, 'default_password_nag', true );107			$email_password = true;108			$user_created   = true;109		} elseif ( ! $user_id ) {110			// Password has been provided.111			$message      = '<em>' . __( 'Your chosen password.' ) . '</em>';112			$user_id      = wp_create_user( $user_name, $user_password, $user_email );113			$user_created = true;114		} else {115			$message = __( 'User already exists. Password inherited.' );116		}117 118		$user = new WP_User( $user_id );119		$user->set_role( 'administrator' );120 121		if ( $user_created ) {122			$user->user_url = $guessurl;123			wp_update_user( $user );124		}125 126		wp_install_defaults( $user_id );

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/upgrade.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.