wp_insert_site( array $data ): int|WP_Error

Compatibility

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

Parameters

$dataarray

Data for the new site that should be inserted.

• $domainstringdefault: empty string

  Site domain.

• $pathstringdefault: '/'

  Site path.

• $network_idintdefault: is the current network ID

  The site's network ID.

• $registeredstringdefault: is the current time

  When the site was registered, in SQL datetime format.

• $last_updatedstringdefault: is the value of $registered

  When the site was last updated, in SQL datetime format.

• $publicintdefault: 1

  Whether the site is public.

• $archivedintdefault: 0

  Whether the site is archived.

• $matureintdefault: 0

  Whether the site is mature.

• $spamintdefault: 0

  Whether the site is spam.

• $deletedintdefault: 0

  Whether the site is deleted.

• $lang_idintdefault: 0

  The site's language ID. Currently unused.

• $user_idint

  User ID for the site administrator. Passed to the wp_initialize_site hook.

• $titlestring

  Site title. Default is 'Site %d' where %d is the site ID. Passed to the wp_initialize_site hook.

• $optionsarraydefault: empty array. Passed to the wp_initialize_site hook

  Custom option $key => $value pairs to use.

• $metaarraydefault: empty array. Passed to the wp_initialize_site hook

  Custom site metadata $key => $value pairs to use.

Return value

int|WP_Error

The new site's ID on success, or error object on failure.

Performance profile

How much work a call to wp_insert_site() 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

Heavy

Reaches the database via ->insert().

Scaling

Constant

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

Instructions

31–117

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

Plugin surface

3 hooks

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

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()called directly
• optionnetwork optionget_network_option()called directly
• sqldatabase query->insert()called directly
• cacheobject cachewp_cache_delete()one call below wp_insert_site()
• serializeserialisationmaybe_unserialize()one call below wp_insert_site()

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

What one call costs · 6 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while wp_insert_site() runs, in this order:

1. 1
   do_action( wp_insert_site )actionline 89 (+45 into the body)

   Fires once a site has been inserted into the database.

2. 2
   do_action( wp_initialize_site )actionline 105 (+61 into the body)

   Fires when a site's initialization routine should be executed.

3. 3
   do_action( wpmu_new_blog )action_deprecatedline 137 (+93 into the body)

   Fires immediately after a new site is created.

Uses · 12

• current_time()Retrieves the current time based on specified type.
• get_current_network_id()Retrieves the current network ID.
• wp_prepare_site_data()Prepares site data for insertion or update in the database.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• clean_blog_cache()Clean the blog cache
• get_site()Retrieves site data given a site ID or site object.
• do_action()Calls the callback functions that have been added to an action hook.
• has_action()Checks if any action has been registered for a hook.
• get_network_option()Retrieves a network's option value based on the option name.
• do_action_deprecated()Fires functions attached to a deprecated action hook.
• WP_Error::__construct()Initializes the error.

Used by · 2

• insert_blog()Store basic site info in the blogs table.
• wpmu_create_blog()Creates a site.

Source code

View on Trac ↗View on GitHub ↗

44function wp_insert_site( array $data ) {45	global $wpdb;46 47	$now = current_time( 'mysql', true );48 49	$defaults = array(50		'domain'       => '',51		'path'         => '/',52		'network_id'   => get_current_network_id(),53		'registered'   => $now,54		'last_updated' => $now,55		'public'       => 1,56		'archived'     => 0,57		'mature'       => 0,58		'spam'         => 0,59		'deleted'      => 0,60		'lang_id'      => 0,61	);62 63	$prepared_data = wp_prepare_site_data( $data, $defaults );64	if ( is_wp_error( $prepared_data ) ) {65		return $prepared_data;66	}67 68	if ( false === $wpdb->insert( $wpdb->blogs, $prepared_data ) ) {69		return new WP_Error( 'db_insert_error', __( 'Could not insert site into the database.' ), $wpdb->last_error );70	}71 72	$site_id = (int) $wpdb->insert_id;73 74	clean_blog_cache( $site_id );75 76	$new_site = get_site( $site_id );77 78	if ( ! $new_site ) {79		return new WP_Error( 'get_site_error', __( 'Could not retrieve site data.' ) );80	}81 82	/**83	 * Fires once a site has been inserted into the database.84	 *85	 * @since 5.1.086	 *87	 * @param WP_Site $new_site New site object.88	 */89	do_action( 'wp_insert_site', $new_site );90 91	// Extract the passed arguments that may be relevant for site initialization.92	$args = array_diff_key( $data, $defaults );93	if ( isset( $args['site_id'] ) ) {94		unset( $args['site_id'] );95	}96 97	/**98	 * Fires when a site's initialization routine should be executed.99	 *100	 * @since 5.1.0101	 *102	 * @param WP_Site $new_site New site object.103	 * @param array   $args     Arguments for the initialization.104	 */105	do_action( 'wp_initialize_site', $new_site, $args );106 107	// Only compute extra hook parameters if the deprecated hook is actually in use.108	if ( has_action( 'wpmu_new_blog' ) ) {109		$user_id = ! empty( $args['user_id'] ) ? $args['user_id'] : 0;110		$meta    = ! empty( $args['options'] ) ? $args['options'] : array();111 112		// WPLANG was passed with `$meta` to the `wpmu_new_blog` hook prior to 5.1.0.113		if ( ! array_key_exists( 'WPLANG', $meta ) ) {114			$meta['WPLANG'] = get_network_option( $new_site->network_id, 'WPLANG' );115		}116 117		/*118		 * Rebuild the data expected by the `wpmu_new_blog` hook prior to 5.1.0 using allowed keys.119		 * The `$allowed_data_fields` matches the one used in `wpmu_create_blog()`.120		 */121		$allowed_data_fields = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );122		$meta                = array_merge( array_intersect_key( $data, array_flip( $allowed_data_fields ) ), $meta );123

Changelog

Introduced in 5.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.8.8 tag, from src/wp-includes/ms-site.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.