WP_REST_Edit_Site_Export_Controller::export(): void|WP_Error
- Since
- 5.9.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-edit-site-export-controller.php:75
Compatibility
- WordPress
- since 5.9.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Return value
void|WP_Error
Performance profile
How much work a call to WP_REST_Edit_Site_Export_Controller::export() 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
- Scaling
- Constant
- Instructions
- 11–39
- Plugin surface
- None
- Called by
- 0
Reads or writes the filesystem via filesize().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 43.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- filesystemfilesystem access
filesize()called directly - hookthird-party callbacks
do_action()one call below WP_REST_Edit_Site_Export_Controller::export() - optionoption read or write
get_option()one call below WP_REST_Edit_Site_Export_Controller::export()
Further down the call graph this can also reach cache, serialize, 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Edit_Site_Export_Controller::export() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_wp_error() | 11 | wp_generate_block_templates_export_file(), is_wp_error(), ->add_data() |
!is_wp_error() | 39 | wp_generate_block_templates_export_file(), is_wp_error(), get_stylesheet(), basename(), header(), header(), filesize(), header(), flush(), readfile(), unlink(), exit() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 43 | 11–39 | 1 | |
| 8.5 | 43 | 11–39 | 1 | |
| 8.4 | 43 | 11–39 | 1 | 2 more instructions than PHP 8.3 |
| 8.3 | 41 | 11–37 | 1 | |
| 8.2 | 41 | 11–37 | 1 | |
| 8.1 | 41 | 11–37 | 1 | |
| 7.4 | 41 | 11–37 | 1 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 3
- wp_generate_block_templates_export_file()Creates an export of the current templates and template parts from the site editor at the specified path in a ZIP file.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- get_stylesheet()Retrieves name of the current stylesheet.
Source code
public function export() { // Generate the export file. $filename = wp_generate_block_templates_export_file(); if ( is_wp_error( $filename ) ) { $filename->add_data( array( 'status' => 500 ) ); return $filename; } $theme_name = basename( get_stylesheet() ); header( 'Content-Type: application/zip' ); header( 'Content-Disposition: attachment; filename=' . $theme_name . '.zip' ); header( 'Content-Length: ' . filesize( $filename ) ); flush(); readfile( $filename ); unlink( $filename ); exit; }Changelog
Introduced in 5.9.0. Unchanged from 6.7.7 through 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/rest-api/endpoints/class-wp-rest-edit-site-export-controller.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.