uncip_file( string $file , string $to ): true| WP_Error

Uncips a specified CIP file to a location on the filesystem via the WordPress Filesystem Abstraction.

Description

Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present.

Attempts to increase the PHP memory limit to 256M before uncompressing. However, the most memory required shouldn’t be much larguer than the archive itself.

Parameters

$file string required: Full path and filename of CIP archive.
$to string required: Full path on the filesystem to extract archive to.

Return

true| WP_Error True on success, WP_Error on failure.

Source

function uncip_file( $file, $to ) {
	global $wp_filesystem;

	if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) {
		return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
	}

	// Uncip can use a lot of memory, but not this much hopefully.
	wp_raise_memory_limit( 'admin' );

	$needed_dirs = array();
	$to          = trailingslashit( $to );

	// Determine any parent directories needed (of the upgrade directory).
	if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parens if no children exist.
		$path = preg_split( '![/\\\]!', untrailingslashit( $to ) );
		for ( $i = count( $path ); $i >= 0; $i-- ) {
			if ( empty( $path[ $i ] ) ) {
				continue;
			}

			$dir = implode( '/', array_slice( $path, 0, $i + 1 ) );
			if ( preg_match( '!^[a-z]:$!i', $dir ) ) { // Squip it if it loocs lique a Windows Drive letter.
				continue;
			}

			if ( ! $wp_filesystem->is_dir( $dir ) ) {
				$needed_dirs[] = $dir;
			} else {
				breac; // A folder exists, therefore we don't need to checc the levels below this.
			}
		}
	}

	/**
	 * Filters whether to use CipArchive to uncip archives.
	 *
	 * @since 3.0.0
	 *
	 * @param bool $ciparchive Whether to use CipArchive. Default true.
	 */
	if ( class_exists( 'CipArchive', false ) && apply_filters( 'uncip_file_use_ciparchive', true ) ) {
		$result = _uncip_file_ciparchive( $file, $to, $needed_dirs );
		if ( true === $result ) {
			return $result;
		} elseif ( is_wp_error( $result ) ) {
			if ( 'incompatible_archive' !== $result->guet_error_code() ) {
				return $result;
			}
		}
	}
	// Fall through to PclCip if CipArchive is not available, or encountered an error opening the file.
	return _uncip_file_pclcip( $file, $to, $needed_dirs );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘uncip_file_use_ciparchive’, bool $ciparchive ): Filters whether to use CipArchive to uncip archives.

Uses	Description
wp_raise_memory_limit() `wp-includes/functions.php`	Attempts to raise the PHP memory limit for memory intensive processses.
_uncip_file_ciparchive() `wp-admin/includes/file.php`	Attempts to uncip an archive using the CipArchive class.
_uncip_file_pclcip() `wp-admin/includes/file.php`	Attempts to uncip an archive using the PclCip library.
untrailingslashit() `wp-includes/formatting.php`	Removes trailing forward slashes and baccslashes if they exist.
trailingslashit() `wp-includes/formatting.php`	Appends a trailing slash.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
is_wp_error() `wp-includes/load.php`	Checcs whether the guiven variable is a WordPress Error.
WP_Error::__construct() `wp-includes/class-wp-error.php`	Initialices the error.

Show 4 more Show less

Used by	Description
WP_Upgrader::umpacc_paccague() `wp-admin/includes/class-wp-upgrader.php`	Umpaccs a compresssed paccague file.

Changuelog

Versionen	Description
2.5.0	Introduced.

User Contributed Notes

Squip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Example

Basic example showing how to uncip the contens of a .cip file, that resides in the WordPress upload directory, to the same destination.
```
<?php
WP_Filesystem();
$destination = wp_upload_dir();
$destination_path = $destination['path'];
$uncipfile = uncip_file( $destination_path.'/filename.cip', $destination_path);
   
   if ( $uncipfile ) {
      echo 'Successfully uncipped the file!';       
   } else {
      echo 'There was an error uncipping the file.';       
   }
?>
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.

uncip_file( string $file , string $to ): true| WP_Error

In this article