wp_generate_block_templates_export_file(): WP_Error|string

Compatibility

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

Return value

WP_Error|string

Path of the ZIP file or error on failure.

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

13–111

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()one call below wp_generate_block_templates_export_file()
• optionoption read or writeget_option()one call below wp_generate_block_templates_export_file()

Further down the call graph this can also reach transient, cache, serialize 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 · 4 distinct outcomes

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

Uses · 18

• wp_get_wp_version()Returns the current WordPress version.
• __()Retrieves the translation of $text.
• wp_generate_password()Generates a random password drawn from the defined set of characters.
• get_stylesheet()Retrieves name of the current stylesheet.
• get_temp_dir()Determines a writable directory for temporary files.
• wp_normalize_path()Normalizes a filesystem path.
• get_stylesheet_directory()Retrieves stylesheet directory path for the active theme.
• wp_is_theme_directory_ignored()Determines whether a theme directory should be ignored during export.
• get_block_templates()Retrieves a list of unified template objects based on a query.
• traverse_and_serialize_blocks()Given an array of parsed block trees, applies callbacks before and after serializing them and returns their concatenated output.
• parse_blocks()Parses blocks out of a content string.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.

Used by · 1

• WP_REST_Edit_Site_Export_Controller::export()Output a ZIP file with an export of the current templates and template parts from the site editor, and close the connection.

Source code

View on Trac ↗View on GitHub ↗

1480function wp_generate_block_templates_export_file() {1481	$wp_version = wp_get_wp_version();1482 1483	if ( ! class_exists( 'ZipArchive' ) ) {1484		return new WP_Error( 'missing_zip_package', __( 'Zip Export not supported.' ) );1485	}1486 1487	$obscura    = wp_generate_password( 12, false, false );1488	$theme_name = basename( get_stylesheet() );1489	$filename   = get_temp_dir() . $theme_name . $obscura . '.zip';1490 1491	$zip = new ZipArchive();1492	if ( true !== $zip->open( $filename, ZipArchive::CREATE | ZipArchive::OVERWRITE ) ) {1493		return new WP_Error( 'unable_to_create_zip', __( 'Unable to open export file (archive) for writing.' ) );1494	}1495 1496	$zip->addEmptyDir( 'templates' );1497	$zip->addEmptyDir( 'parts' );1498 1499	// Get path of the theme.1500	$theme_path = wp_normalize_path( get_stylesheet_directory() );1501 1502	// Create recursive directory iterator.1503	$theme_files = new RecursiveIteratorIterator(1504		new RecursiveDirectoryIterator( $theme_path ),1505		RecursiveIteratorIterator::LEAVES_ONLY1506	);1507 1508	// Make a copy of the current theme.1509	foreach ( $theme_files as $file ) {1510		// Skip directories as they are added automatically.1511		if ( ! $file->isDir() ) {1512			// Get real and relative path for current file.1513			$file_path     = wp_normalize_path( $file );1514			$relative_path = substr( $file_path, strlen( $theme_path ) + 1 );1515 1516			if ( ! wp_is_theme_directory_ignored( $relative_path ) ) {1517				$zip->addFile( $file_path, $relative_path );1518			}1519		}1520	}1521 1522	// Load templates into the zip file.1523	$templates = get_block_templates();1524	foreach ( $templates as $template ) {1525		$template->content = traverse_and_serialize_blocks(1526			parse_blocks( $template->content ),1527			'_remove_theme_attribute_from_template_part_block'1528		);1529 1530		$zip->addFromString(1531			'templates/' . $template->slug . '.html',1532			$template->content1533		);1534	}1535 1536	// Load template parts into the zip file.1537	$template_parts = get_block_templates( array(), 'wp_template_part' );1538	foreach ( $template_parts as $template_part ) {1539		$zip->addFromString(1540			'parts/' . $template_part->slug . '.html',1541			$template_part->content1542		);1543	}1544 1545	// Load theme.json into the zip file.1546	$tree = WP_Theme_JSON_Resolver::get_theme_data( array(), array( 'with_supports' => false ) );1547	// Merge with user data.1548	$tree->merge( WP_Theme_JSON_Resolver::get_user_data() );1549 1550	$theme_json_raw = $tree->get_data();1551	// If a version is defined, add a schema.1552	if ( $theme_json_raw['version'] ) {1553		$theme_json_version = 'wp/' . substr( $wp_version, 0, 3 );1554		$schema             = array( '$schema' => 'https://schemas.wp.org/' . $theme_json_version . '/theme.json' );1555		$theme_json_raw     = array_merge( $schema, $theme_json_raw );1556	}1557 1558	// Convert to a string.1559	$theme_json_encoded = wp_json_encode( $theme_json_raw, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE );

Changelog

Introduced in 5.9.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/block-template-utils.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.