W3cubDocs

/WordPress

wp_initialize_site( int|WP_Site $site_id, array $args = array() )

Runs the initialization routine for a given site.

Description

This process includes creating the site’s database tables and populating them with defaults.

Parameters

$site_id

(int|WP_Site) (Required) Site ID or object.

$args

(array) (Optional) Arguments to modify the initialization behavior.

  • 'user_id'
    (int) Required. User ID for the site administrator.
  • 'title'
    (string) Site title. Default is 'Site %d' where %d is the site ID.
  • 'options'
    (array) Custom option $key => $value pairs to use.
  • 'meta'
    (array) Custom site metadata $key => $value pairs to use.

Default value: array()

Return

(bool|WP_Error) True on success, or error object on failure.

Source

File: wp-includes/ms-site.php 

function wp_initialize_site( $site_id, array $args = array() ) {
	global $wpdb, $wp_roles;

	if ( empty( $site_id ) ) {
		return new WP_Error( 'site_empty_id', __( 'Site ID must not be empty.' ) );
	}

	$site = get_site( $site_id );
	if ( ! $site ) {
		return new WP_Error( 'site_invalid_id', __( 'Site with the ID does not exist.' ) );
	}

	if ( wp_is_site_initialized( $site ) ) {
		return new WP_Error( 'site_already_initialized', __( 'The site appears to be already initialized.' ) );
	}

	$network = get_network( $site->network_id );
	if ( ! $network ) {
		$network = get_network();
	}

	$args = wp_parse_args(
		$args,
		array(
			'user_id' => 0,
			/* translators: %d: Site ID. */
			'title'   => sprintf( __( 'Site %d' ), $site->id ),
			'options' => array(),
			'meta'    => array(),
		)
	);

	/**
	 * Filters the arguments for initializing a site.
	 *
	 * @since 5.1.0
	 *
	 * @param array      $args    Arguments to modify the initialization behavior.
	 * @param WP_Site    $site    Site that is being initialized.
	 * @param WP_Network $network Network that the site belongs to.
	 */
	$args = apply_filters( 'wp_initialize_site_args', $args, $site, $network );

	$orig_installing = wp_installing();
	if ( ! $orig_installing ) {
		wp_installing( true );
	}

	$switch = false;
	if ( get_current_blog_id() !== $site->id ) {
		$switch = true;
		switch_to_blog( $site->id );
	}

	require_once ABSPATH . 'wp-admin/includes/upgrade.php';

	// Set up the database tables.
	make_db_current_silent( 'blog' );

	$home_scheme    = 'http';
	$siteurl_scheme = 'http';
	if ( ! is_subdomain_install() ) {
		if ( 'https' === parse_url( get_home_url( $network->site_id ), PHP_URL_SCHEME ) ) {
			$home_scheme = 'https';
		}
		if ( 'https' === parse_url( get_network_option( $network->id, 'siteurl' ), PHP_URL_SCHEME ) ) {
			$siteurl_scheme = 'https';
		}
	}

	// Populate the site's options.
	populate_options(
		array_merge(
			array(
				'home'        => untrailingslashit( $home_scheme . '://' . $site->domain . $site->path ),
				'siteurl'     => untrailingslashit( $siteurl_scheme . '://' . $site->domain . $site->path ),
				'blogname'    => wp_unslash( $args['title'] ),
				'admin_email' => '',
				'upload_path' => get_network_option( $network->id, 'ms_files_rewriting' ) ? UPLOADBLOGSDIR . "/{$site->id}/files" : get_blog_option( $network->site_id, 'upload_path' ),
				'blog_public' => (int) $site->public,
				'WPLANG'      => get_network_option( $network->id, 'WPLANG' ),
			),
			$args['options']
		)
	);

	// Clean blog cache after populating options.
	clean_blog_cache( $site );

	// Populate the site's roles.
	populate_roles();
	$wp_roles = new WP_Roles();

	// Populate metadata for the site.
	populate_site_meta( $site->id, $args['meta'] );

	// Remove all permissions that may exist for the site.
	$table_prefix = $wpdb->get_blog_prefix();
	delete_metadata( 'user', 0, $table_prefix . 'user_level', null, true );   // Delete all.
	delete_metadata( 'user', 0, $table_prefix . 'capabilities', null, true ); // Delete all.

	// Install default site content.
	wp_install_defaults( $args['user_id'] );

	// Set the site administrator.
	add_user_to_blog( $site->id, $args['user_id'], 'administrator' );
	if ( ! user_can( $args['user_id'], 'manage_network' ) && ! get_user_meta( $args['user_id'], 'primary_blog', true ) ) {
		update_user_meta( $args['user_id'], 'primary_blog', $site->id );
	}

	if ( $switch ) {
		restore_current_blog();
	}

	wp_installing( $orig_installing );

	return true;
}

Uses

Uses Description
wp-includes/ms-site.php: wp_is_site_initialized()

Checks whether a site is initialized.
wp-includes/ms-site.php: wp_initialize_site_args

Filters the arguments for initializing a site.
wp-admin/includes/schema.php: populate_site_meta()

Creates WordPress site meta and sets the default values.
wp-includes/ms-network.php: get_network()

Retrieves network data given a network ID or network object.
wp-includes/ms-site.php: get_site()

Retrieves site data given a site ID or site object.
wp-includes/load.php: wp_installing()

Check or set whether WordPress is in “installation” mode.
wp-includes/option.php: get_network_option()

Retrieves a network’s option value based on the option name.
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: 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-includes/capabilities.php: user_can()

Returns whether a particular user has the specified capability.
wp-includes/class-wp-roles.php: WP_Roles::__construct()

Constructor
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: wp_unslash()

Remove slashes from a string or array of strings.
wp-includes/formatting.php: untrailingslashit()

Removes trailing forward slashes and backslashes if they exist.
wp-includes/load.php: get_current_blog_id()

Retrieve the current site ID.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
wp-includes/link-template.php: get_home_url()

Retrieves the URL for a given site where the front end is accessible.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/user.php: get_user_meta()

Retrieve user meta field for a user.
wp-includes/user.php: update_user_meta()

Update user meta field based on user ID.
wp-includes/ms-functions.php: add_user_to_blog()

Adds a user to a blog, along with specifying the user’s role.
wp-includes/ms-load.php: is_subdomain_install()

Whether a subdomain configuration is enabled.
wp-includes/ms-blogs.php: switch_to_blog()

Switch the current blog.
wp-includes/ms-blogs.php: restore_current_blog()

Restore the current blog, after calling switch_to_blog().
wp-includes/ms-blogs.php: get_blog_option()

Retrieve option value for a given blog id based on name of option.
wp-includes/ms-site.php: clean_blog_cache()

Clean the blog cache
wp-includes/wp-db.php: wpdb::get_blog_prefix()

Gets blog prefix.
wp-includes/meta.php: delete_metadata()

Deletes metadata for the specified object.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
5.1.0 Introduced.

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