WP_Customize_Manager::import_theme_starter_content( array $starter_content = 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

$starter_contentarrayoptional

Starter content. Defaults to get_theme_starter_content().Default: array()

Performance profile

How much work a call to WP_Customize_Manager::import_theme_starter_content() 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_post().

Scaling

Scales with input

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

Instructions

95–141

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• optionoption read or writeget_option()called directly
• querycontent queryget_post()called directly
• serializeserialisationmaybe_serialize()called directly
• hookthird-party callbacksapply_filters()one call below WP_Customize_Manager::import_theme_starter_content()
• cacheobject cachewp_cache_get()one call below WP_Customize_Manager::import_theme_starter_content()

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Manager::import_theme_starter_content() 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 · 31

• get_theme_starter_content()Expands a theme's starter content configuration using core-provided data.
• get_post_status()Retrieves the post status based on the post ID.
• get_option()Retrieves an option value based on an option name.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• get_post_meta()Retrieves a post meta field for the given post ID.
• get_post_stati()Gets a list of post statuses.
• get_attached_file()Retrieves attached file path based on attachment ID.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
• wp_update_attachment_metadata()Updates metadata for an attachment.
• update_post_meta()Updates a post meta field based on the given post ID.
• wp_tempnam()Returns a filename of a temporary unique file.

Source code

View on Trac ↗View on GitHub ↗

1203	public function import_theme_starter_content( $starter_content = array() ) {1204		if ( empty( $starter_content ) ) {1205			$starter_content = get_theme_starter_content();1206		}1207 1208		$changeset_data = array();1209		if ( $this->changeset_post_id() ) {1210			/*1211			 * Don't re-import starter content into a changeset saved persistently.1212			 * This will need to be revisited in the future once theme switching1213			 * is allowed with drafted/scheduled changesets, since switching to1214			 * another theme could result in more starter content being applied.1215			 * However, when doing an explicit save it is currently possible for1216			 * nav menus and nav menu items specifically to lose their starter_content1217			 * flags, thus resulting in duplicates being created since they fail1218			 * to get re-used. See #40146.1219			 */1220			if ( 'auto-draft' !== get_post_status( $this->changeset_post_id() ) ) {1221				return;1222			}1223 1224			$changeset_data = $this->get_changeset_post_data( $this->changeset_post_id() );1225		}1226 1227		$sidebars_widgets = isset( $starter_content['widgets'] ) && ! empty( $this->widgets ) ? $starter_content['widgets'] : array();1228		$attachments      = isset( $starter_content['attachments'] ) && ! empty( $this->nav_menus ) ? $starter_content['attachments'] : array();1229		$posts            = isset( $starter_content['posts'] ) && ! empty( $this->nav_menus ) ? $starter_content['posts'] : array();1230		$options          = $starter_content['options'] ?? array();1231		$nav_menus        = isset( $starter_content['nav_menus'] ) && ! empty( $this->nav_menus ) ? $starter_content['nav_menus'] : array();1232		$theme_mods       = $starter_content['theme_mods'] ?? array();1233 1234		// Widgets.1235		$max_widget_numbers = array();1236		foreach ( $sidebars_widgets as $sidebar_id => $widgets ) {1237			$sidebar_widget_ids = array();1238			foreach ( $widgets as $widget ) {1239				list( $id_base, $instance ) = $widget;1240 1241				if ( ! isset( $max_widget_numbers[ $id_base ] ) ) {1242 1243					// When $settings is an array-like object, get an intrinsic array for use with array_keys().1244					$settings = get_option( "widget_{$id_base}", array() );1245					if ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) {1246						$settings = $settings->getArrayCopy();1247					}1248 1249					unset( $settings['_multiwidget'] );1250 1251					// Find the max widget number for this type.1252					$widget_numbers = array_keys( $settings );1253					if ( count( $widget_numbers ) > 0 ) {1254						$widget_numbers[]               = 1;1255						$max_widget_numbers[ $id_base ] = max( ...$widget_numbers );1256					} else {1257						$max_widget_numbers[ $id_base ] = 1;1258					}1259				}1260				$max_widget_numbers[ $id_base ] += 1;1261 1262				$widget_id  = sprintf( '%s-%d', $id_base, $max_widget_numbers[ $id_base ] );1263				$setting_id = sprintf( 'widget_%s[%d]', $id_base, $max_widget_numbers[ $id_base ] );1264 1265				$setting_value = $this->widgets->sanitize_widget_js_instance( $instance );1266				if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) {1267					$this->set_post_value( $setting_id, $setting_value );1268					$this->pending_starter_content_settings_ids[] = $setting_id;1269				}1270				$sidebar_widget_ids[] = $widget_id;1271			}1272 1273			$setting_id = sprintf( 'sidebars_widgets[%s]', $sidebar_id );1274			if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) {1275				$this->set_post_value( $setting_id, $sidebar_widget_ids );1276				$this->pending_starter_content_settings_ids[] = $setting_id;1277			}1278		}1279 1280		$starter_content_auto_draft_post_ids = array();1281		if ( ! empty( $changeset_data['nav_menus_created_posts']['value'] ) ) {1282			$starter_content_auto_draft_post_ids = array_merge( $starter_content_auto_draft_post_ids, $changeset_data['nav_menus_created_posts']['value'] );

Changelog

Introduced in 4.7.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.1.0 tag, from src/wp-includes/class-wp-customize-manager.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.