Plugin_Installer_Skin::do_overwrite(): bool

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

bool

Whether the plugin can be overwritten and HTML was outputted.

Performance profile

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

Moderate

Only touches the object cache, via wp_cache_get().

Scaling

Scales with input

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

Instructions

4–257

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

Plugin surface

2 hooks

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

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()called directly
• cacheobject cachewp_cache_get()one call below Plugin_Installer_Skin::do_overwrite()

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

What one call costs · 20 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while Plugin_Installer_Skin::do_overwrite() runs, in this order:

1. 1
   apply_filters( install_plugin_overwrite_comparison )filterline 260 (+68 into the body)

   Filters the compare table output for overwriting a plugin package on upload.

2. 2
   apply_filters( install_plugin_overwrite_actions )filterline 343 (+151 into the body)

   Filters the list of action links available following a single plugin installation failure when overwriting is allowed.

Uses · 14

• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_plugins()Checks the plugins directory and retrieve all plugin files with plugin data.
• esc_html__()Retrieves the translation of $text and escapes it for safe use in HTML output.
• __()Retrieves the translation of $text.
• esc_html_x()Translates string with gettext context, and escapes it for safe use in HTML output.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_php_version_compatible()Checks compatibility with the current PHP version.
• esc_html()Escaping for HTML blocks.
• is_wp_version_compatible()Checks compatibility with the current WordPress version.
• wp_get_wp_version()Returns the current WordPress version.
• wp_nonce_url()Retrieves URL with nonce added to URL query.

Used by · 1

• Plugin_Installer_Skin::after()Performs an action following a plugin install.

Source code

View on Trac ↗View on GitHub ↗

192	private function do_overwrite() {193		if ( 'upload' !== $this->type || ! is_wp_error( $this->result ) || 'folder_exists' !== $this->result->get_error_code() ) {194			return false;195		}196 197		$folder = $this->result->get_error_data( 'folder_exists' );198		$folder = ltrim( substr( $folder, strlen( WP_PLUGIN_DIR ) ), '/' );199 200		$current_plugin_data = false;201		$all_plugins         = get_plugins();202 203		foreach ( $all_plugins as $plugin => $plugin_data ) {204			if ( strrpos( $plugin, $folder ) !== 0 ) {205				continue;206			}207 208			$current_plugin_data = $plugin_data;209		}210 211		$new_plugin_data = $this->upgrader->new_plugin_data;212 213		if ( ! $current_plugin_data || ! $new_plugin_data ) {214			return false;215		}216 217		echo '<h2 class="update-from-upload-heading">' . esc_html__( 'This plugin is already installed.' ) . '</h2>';218 219		$this->is_downgrading = version_compare( $current_plugin_data['Version'], $new_plugin_data['Version'], '>' );220 221		$rows = array(222			'Name'        => __( 'Plugin name' ),223			'Version'     => __( 'Version' ),224			'Author'      => __( 'Author' ),225			'RequiresWP'  => __( 'Required WordPress version' ),226			'RequiresPHP' => __( 'Required PHP version' ),227		);228 229		$table  = '<table class="update-from-upload-comparison"><tbody>';230		$table .= '<tr><th></th><th>' . esc_html_x( 'Current', 'plugin' ) . '</th>';231		$table .= '<th>' . esc_html_x( 'Uploaded', 'plugin' ) . '</th></tr>';232 233		$is_same_plugin = true; // Let's consider only these rows.234 235		foreach ( $rows as $field => $label ) {236			$old_value = ! empty( $current_plugin_data[ $field ] ) ? (string) $current_plugin_data[ $field ] : '-';237			$new_value = ! empty( $new_plugin_data[ $field ] ) ? (string) $new_plugin_data[ $field ] : '-';238 239			$is_same_plugin = $is_same_plugin && ( $old_value === $new_value );240 241			$diff_field   = ( 'Version' !== $field && $new_value !== $old_value );242			$diff_version = ( 'Version' === $field && $this->is_downgrading );243 244			$table .= '<tr><td class="name-label">' . $label . '</td><td>' . wp_strip_all_tags( $old_value ) . '</td>';245			$table .= ( $diff_field || $diff_version ) ? '<td class="warning">' : '<td>';246			$table .= wp_strip_all_tags( $new_value ) . '</td></tr>';247		}248 249		$table .= '</tbody></table>';250 251		/**252		 * Filters the compare table output for overwriting a plugin package on upload.253		 *254		 * @since 5.5.0255		 *256		 * @param string $table               The output table with Name, Version, Author, RequiresWP, and RequiresPHP info.257		 * @param array  $current_plugin_data Array with current plugin data.258		 * @param array  $new_plugin_data     Array with uploaded plugin data.259		 */260		echo apply_filters( 'install_plugin_overwrite_comparison', $table, $current_plugin_data, $new_plugin_data );261 262		$install_actions = array();263		$can_update      = true;264 265		$blocked_message  = '<p>' . esc_html__( 'The plugin cannot be updated due to the following:' ) . '</p>';266		$blocked_message .= '<ul class="ul-disc">';267 268		$requires_php = isset( $new_plugin_data['RequiresPHP'] ) ? $new_plugin_data['RequiresPHP'] : null;269		$requires_wp  = isset( $new_plugin_data['RequiresWP'] ) ? $new_plugin_data['RequiresWP'] : null;270 271		if ( ! is_php_version_compatible( $requires_php ) ) {

Changelog

Introduced in 5.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 6.7.7 tag, from src/wp-admin/includes/class-plugin-installer-skin.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.