populate_options( array $options = array() )

Compatibility

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

Parameters

$optionsarrayoptional

Custom option $key => $value pairs to use. Default empty array.Default: array()

Performance profile

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

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

202–242

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

Plugin surface

1 hook

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

Called by

4

4 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
• serializeserialisationmaybe_serialize()called directly
• optionoption read or writeupdate_option()called directly
• sqldatabase query->get_col()called directly
• cacheobject cachewp_cache_get()one call below populate_options()

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

What one call costs · 32 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   do_action( populate_options )actionline 371 (+9 into the body)

   Fires before creating WordPress options and populating their default values.

Uses · 14

• wp_guess_url()Guesses the URL for the site.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_get_theme()Gets a WP_Theme object for a theme.
• _x()Retrieves translated string with gettext context.
• __()Retrieves the translation of $text.
• is_multisite()Determines whether Multisite is enabled.
• wp_parse_args()Merges user defined arguments into defaults array.
• maybe_serialize()Serializes data, if needed.
• sanitize_option()Sanitizes various option values based on the nature of the option.
• __get_option()Utility version of get_option that is private to installation/upgrade.
• update_option()Updates the value of an option that was already added.
• delete_option()Removes an option by name. Prevents removal of protected WordPress options.

Used by · 4

• install_blog()Install an empty blog.
• upgrade_all()Functions to be called in installation and upgrade scripts.
• wp_initialize_site()Runs the initialization routine for a given site.
• wp_install()Installs the site.

Source code

View on Trac ↗View on GitHub ↗

362function populate_options( array $options = array() ) {363	global $wpdb, $wp_db_version, $wp_current_db_version;364 365	$guessurl = wp_guess_url();366	/**367	 * Fires before creating WordPress options and populating their default values.368	 *369	 * @since 2.6.0370	 */371	do_action( 'populate_options' );372 373	// If WP_DEFAULT_THEME doesn't exist, fall back to the latest core default theme.374	$stylesheet = WP_DEFAULT_THEME;375	$template   = WP_DEFAULT_THEME;376	$theme      = wp_get_theme( WP_DEFAULT_THEME );377	if ( ! $theme->exists() ) {378		$theme = WP_Theme::get_core_default_theme();379	}380 381	// If we can't find a core default theme, WP_DEFAULT_THEME is the best we can do.382	if ( $theme ) {383		$stylesheet = $theme->get_stylesheet();384		$template   = $theme->get_template();385	}386 387	$timezone_string = '';388	$gmt_offset      = 0;389	/*390	 * translators: default GMT offset or timezone string. Must be either a valid offset (-12 to 14)391	 * or a valid timezone string (America/New_York). See https://www.php.net/manual/en/timezones.php392	 * for all timezone strings currently supported by PHP.393	 *394	 * Important: When a previous timezone string, like `Europe/Kiev`, has been superseded by an395	 * updated one, like `Europe/Kyiv`, as a rule of thumb, the **old** timezone name should be used396	 * in the "translation" to allow for the default timezone setting to be PHP cross-version compatible,397	 * as old timezone names will be recognized in new PHP versions, while new timezone names cannot398	 * be recognized in old PHP versions.399	 *400	 * To verify which timezone strings are available in the _oldest_ PHP version supported, you can401	 * use https://3v4l.org/6YQAt#v5.6.20 and replace the "BR" (Brazil) in the code line with the402	 * country code for which you want to look up the supported timezone names.403	 */404	$offset_or_tz = _x( '0', 'default GMT offset or timezone string' );405	if ( is_numeric( $offset_or_tz ) ) {406		$gmt_offset = $offset_or_tz;407	} elseif ( $offset_or_tz && in_array( $offset_or_tz, timezone_identifiers_list( DateTimeZone::ALL_WITH_BC ), true ) ) {408		$timezone_string = $offset_or_tz;409	}410 411	$defaults = array(412		'siteurl'                         => $guessurl,413		'home'                            => $guessurl,414		'blogname'                        => __( 'My Site' ),415		'blogdescription'                 => '',416		'users_can_register'              => 0,417		'admin_email'                     => '[email protected]',418		/* translators: Default start of the week. 0 = Sunday, 1 = Monday. */419		'start_of_week'                   => _x( '1', 'start of week' ),420		'use_balanceTags'                 => 0,421		'use_smilies'                     => 1,422		'require_name_email'              => 1,423		'comments_notify'                 => 1,424		'posts_per_rss'                   => 10,425		'rss_use_excerpt'                 => 0,426		'mailserver_url'                  => 'mail.example.com',427		'mailserver_login'                => '[email protected]',428		'mailserver_pass'                 => '',429		'mailserver_port'                 => 110,430		'default_category'                => 1,431		'default_comment_status'          => 'open',432		'default_ping_status'             => 'open',433		'default_pingback_flag'           => 1,434		'posts_per_page'                  => 10,435		/* translators: Default date format, see https://www.php.net/manual/datetime.format.php */436		'date_format'                     => __( 'F j, Y' ),437		/* translators: Default time format, see https://www.php.net/manual/datetime.format.php */438		'time_format'                     => __( 'g:i a' ),439		/* translators: Links last updated date format, see https://www.php.net/manual/datetime.format.php */440		'links_updated_date_format'       => __( 'F j, Y g:i a' ),441		'comment_moderation'              => 0,

Changelog

Introduced in 1.5.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 7.0.4 tag, from src/wp-admin/includes/schema.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.