Language_Pack_Upgrader::clear_destination( string $remote_destination ): bool|WP_Error

Compatibility

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

Parameters

$remote_destinationstring

The location on the remote filesystem to be cleared.

Return value

bool|WP_Error

True upon success, WP_Error on failure.

Performance profile

How much work a call to Language_Pack_Upgrader::clear_destination() 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 or writes the filesystem via glob().

Scaling

Scales with input

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

Instructions

55–108

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

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

• filesystemfilesystem accessglob()called directly
• sqldatabase query->delete()called directly

What one call costs · 3 distinct outcomes

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

Uses · 1

• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

410	public function clear_destination( $remote_destination ) {411		global $wp_filesystem;412 413		$language_update    = $this->skin->language_update;414		$language_directory = WP_LANG_DIR . '/'; // Local path for use with glob().415 416		if ( 'core' === $language_update->type ) {417			$files = array(418				$remote_destination . $language_update->language . '.po',419				$remote_destination . $language_update->language . '.mo',420				$remote_destination . $language_update->language . '.l10n.php',421				$remote_destination . 'admin-' . $language_update->language . '.po',422				$remote_destination . 'admin-' . $language_update->language . '.mo',423				$remote_destination . 'admin-' . $language_update->language . '.l10n.php',424				$remote_destination . 'admin-network-' . $language_update->language . '.po',425				$remote_destination . 'admin-network-' . $language_update->language . '.mo',426				$remote_destination . 'admin-network-' . $language_update->language . '.l10n.php',427				$remote_destination . 'continents-cities-' . $language_update->language . '.po',428				$remote_destination . 'continents-cities-' . $language_update->language . '.mo',429				$remote_destination . 'continents-cities-' . $language_update->language . '.l10n.php',430			);431 432			$json_translation_files = glob( $language_directory . $language_update->language . '-*.json' );433			if ( $json_translation_files ) {434				foreach ( $json_translation_files as $json_translation_file ) {435					$files[] = str_replace( $language_directory, $remote_destination, $json_translation_file );436				}437			}438		} else {439			$files = array(440				$remote_destination . $language_update->slug . '-' . $language_update->language . '.po',441				$remote_destination . $language_update->slug . '-' . $language_update->language . '.mo',442				$remote_destination . $language_update->slug . '-' . $language_update->language . '.l10n.php',443			);444 445			$language_directory     = $language_directory . $language_update->type . 's/';446			$json_translation_files = glob( $language_directory . $language_update->slug . '-' . $language_update->language . '-*.json' );447			if ( $json_translation_files ) {448				foreach ( $json_translation_files as $json_translation_file ) {449					$files[] = str_replace( $language_directory, $remote_destination, $json_translation_file );450				}451			}452		}453 454		$files = array_filter( $files, array( $wp_filesystem, 'exists' ) );455 456		// No files to delete.457		if ( ! $files ) {458			return true;459		}460 461		// Check all files are writable before attempting to clear the destination.462		$unwritable_files = array();463 464		// Check writability.465		foreach ( $files as $file ) {466			if ( ! $wp_filesystem->is_writable( $file ) ) {467				// Attempt to alter permissions to allow writes and try again.468				$wp_filesystem->chmod( $file, FS_CHMOD_FILE );469				if ( ! $wp_filesystem->is_writable( $file ) ) {470					$unwritable_files[] = $file;471				}472			}473		}474 475		if ( ! empty( $unwritable_files ) ) {476			return new WP_Error( 'files_not_writable', $this->strings['files_not_writable'], implode( ', ', $unwritable_files ) );477		}478 479		foreach ( $files as $file ) {480			if ( ! $wp_filesystem->delete( $file ) ) {481				return new WP_Error( 'remove_old_failed', $this->strings['remove_old_failed'] );482			}483		}484 485		return true;486	}

Changelog

Introduced in 5.1.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.9.7 tag, from src/wp-admin/includes/class-language-pack-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.