File_Upload_Upgrader::__construct( string $form, string $urlholder )

Compatibility

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

Parameters

$formstring

The name of the form the file was uploaded from.

$urlholderstring

The name of the GET parameter that holds the filename.

Performance profile

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

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

36–130

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

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

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()one call below File_Upload_Upgrader::__construct()

Further down the call graph this can also reach option, transient, cache and serialize. 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 File_Upload_Upgrader::__construct() can have, taken from its control-flow graph on PHP 8.5.

Uses · 13

• wp_die()Kills WordPress execution and displays HTML page with an error message.
• __()Retrieves the translation of $text.
• wp_handle_upload()Wrapper for _wp_handle_upload().
• wp_zip_file_is_valid()Determines whether the given file is a valid ZIP file.
• wp_delete_file()Deletes a file.
• self_admin_url()Retrieves the URL to the admin area for either the current site or the network depending on context.
• wp_insert_attachment()Inserts an attachment.
• wp_schedule_single_event()Schedules an event to run only once.
• get_post()Retrieves post data given a post ID or post object.
• get_attached_file()Retrieves attached file path based on attachment ID.
• wp_upload_dir()Returns an array containing the current upload directory's path and URL.
• sanitize_file_name()Sanitizes a filename, replacing whitespace with dashes.

Source code

View on Trac ↗View on GitHub ↗

54	public function __construct( $form, $urlholder ) {55 56		if ( empty( $_FILES[ $form ]['name'] ) && empty( $_GET[ $urlholder ] ) ) {57			wp_die( __( 'Please select a file' ) );58		}59 60		// Handle a newly uploaded file. Else, assume it's already been uploaded.61		if ( ! empty( $_FILES ) ) {62			$overrides = array(63				'test_form' => false,64				'test_type' => false,65			);66			$file      = wp_handle_upload( $_FILES[ $form ], $overrides );67 68			if ( isset( $file['error'] ) ) {69				wp_die( $file['error'] );70			}71 72			if ( 'pluginzip' === $form || 'themezip' === $form ) {73				if ( ! wp_zip_file_is_valid( $file['file'] ) ) {74					wp_delete_file( $file['file'] );75 76					if ( 'pluginzip' === $form ) {77						$plugins_page = sprintf(78							'<a href="%s">%s</a>',79							self_admin_url( 'plugin-install.php' ),80							__( 'Return to the Plugin Installer' )81						);82						wp_die( __( 'Incompatible Archive.' ) . '<br />' . $plugins_page );83					}84 85					if ( 'themezip' === $form ) {86						$themes_page = sprintf(87							'<a href="%s" target="_parent">%s</a>',88							self_admin_url( 'theme-install.php' ),89							__( 'Return to the Theme Installer' )90						);91						wp_die( __( 'Incompatible Archive.' ) . '<br />' . $themes_page );92					}93				}94			}95 96			$this->filename = $_FILES[ $form ]['name'];97			$this->package  = $file['file'];98 99			// Construct the attachment array.100			$attachment = array(101				'post_title'     => $this->filename,102				'post_content'   => $file['url'],103				'post_mime_type' => $file['type'],104				'guid'           => $file['url'],105				'context'        => 'upgrader',106				'post_status'    => 'private',107			);108 109			// Save the data.110			$this->id = wp_insert_attachment( $attachment, $file['file'] );111 112			// Schedule a cleanup for 2 hours from now in case of failed installation.113			wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $this->id ) );114 115		} elseif ( is_numeric( $_GET[ $urlholder ] ) ) {116			// Numeric Package = previously uploaded file, see above.117			$this->id   = (int) $_GET[ $urlholder ];118			$attachment = get_post( $this->id );119			if ( empty( $attachment ) ) {120				wp_die( __( 'Please select a file' ) );121			}122 123			$this->filename = $attachment->post_title;124			$this->package  = get_attached_file( $attachment->ID );125		} else {126			// Else, It's set to something, Back compat for plugins using the old (pre-3.3) File_Uploader handler.127			$uploads = wp_upload_dir();128			if ( ! ( $uploads && false === $uploads['error'] ) ) {129				wp_die( $uploads['error'] );130			}131 132			$this->filename = sanitize_file_name( $_GET[ $urlholder ] );133			$this->package  = $uploads['basedir'] . '/' . $this->filename;

Changelog

Introduced in 2.8.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-admin/includes/class-file-upload-upgrader.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.