wp_install_defaults( int $user_id )

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

$user_idint

User ID.

Performance profile

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

249–417

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

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

What it touches

• optionoption read or writeget_option()called directly
• sqldatabase query->insert()called directly
• hookthird-party callbacksapply_filters()one call below wp_install_defaults()
• cacheobject cachewp_cache_get()one call below wp_install_defaults()
• serializeserialisationmaybe_unserialize()one call below wp_install_defaults()

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 · 255 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 18

• __()Retrieves the translation of $text.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• _x()Retrieves translated string with gettext context.
• current_time()Retrieves the current time based on specified type.
• get_option()Retrieves an option value based on an option name.
• is_multisite()Determines whether Multisite is enabled.
• get_site_option()Retrieve an option value for the current network based on name of option.
• esc_url()Checks and cleans a URL.
• network_home_url()Retrieves the home URL for the current network.
• get_network()Retrieves network data given a network ID or network object.
• update_posts_count()Updates a blog's post count.
• admin_url()Retrieves the URL to the admin area for the current site.

Used by · 3

• install_blog_defaults()Set blog defaults.
• wp_initialize_site()Runs the initialization routine for a given site.
• wp_install()Installs the site.

Source code

View on Trac ↗View on GitHub ↗

178	function wp_install_defaults( $user_id ) {179		global $wpdb, $wp_rewrite, $table_prefix;180 181		// Default category.182		$cat_name = __( 'Uncategorized' );183		/* translators: Default category slug. */184		$cat_slug = sanitize_title( _x( 'Uncategorized', 'Default category slug' ) );185 186		$cat_id = 1;187 188		$wpdb->insert(189			$wpdb->terms,190			array(191				'term_id'    => $cat_id,192				'name'       => $cat_name,193				'slug'       => $cat_slug,194				'term_group' => 0,195			)196		);197		$wpdb->insert(198			$wpdb->term_taxonomy,199			array(200				'term_id'     => $cat_id,201				'taxonomy'    => 'category',202				'description' => '',203				'parent'      => 0,204				'count'       => 1,205			)206		);207		$cat_tt_id = $wpdb->insert_id;208 209		// First post.210		$now             = current_time( 'mysql' );211		$now_gmt         = current_time( 'mysql', 1 );212		$first_post_guid = get_option( 'home' ) . '/?p=1';213 214		if ( is_multisite() ) {215			$first_post = get_site_option( 'first_post' );216 217			if ( ! $first_post ) {218				$first_post = "<!-- wp:paragraph -->\n<p>" .219				/* translators: First post content. %s: Site link. */220				__( 'Welcome to %s. This is your first post. Edit or delete it, then start writing!' ) .221				"</p>\n<!-- /wp:paragraph -->";222			}223 224			$first_post = sprintf(225				$first_post,226				sprintf( '<a href="%s">%s</a>', esc_url( network_home_url() ), get_network()->site_name )227			);228 229			// Back-compat for pre-4.4.230			$first_post = str_replace( 'SITE_URL', esc_url( network_home_url() ), $first_post );231			$first_post = str_replace( 'SITE_NAME', get_network()->site_name, $first_post );232		} else {233			$first_post = "<!-- wp:paragraph -->\n<p>" .234			/* translators: First post content. %s: Site link. */235			__( 'Welcome to WordPress. This is your first post. Edit or delete it, then start writing!' ) .236			"</p>\n<!-- /wp:paragraph -->";237		}238 239		$wpdb->insert(240			$wpdb->posts,241			array(242				'post_author'           => $user_id,243				'post_date'             => $now,244				'post_date_gmt'         => $now_gmt,245				'post_content'          => $first_post,246				'post_excerpt'          => '',247				'post_title'            => __( 'Hello world!' ),248				/* translators: Default post slug. */249				'post_name'             => sanitize_title( _x( 'hello-world', 'Default post slug' ) ),250				'post_modified'         => $now,251				'post_modified_gmt'     => $now_gmt,252				'guid'                  => $first_post_guid,253				'comment_count'         => 1,254				'to_ping'               => '',255				'pinged'                => '',256				'post_content_filtered' => '',257			)

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.8.8 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.