Changeset 13007 for trunk/wp-admin/includes/file.php

Timestamp:

02/07/2010 05:07:36 AM (15 years ago)

Author:

dd32

Message:

PHPdoc for _unzip_file_pclzip & _unzip_file_ziparchive. See #10403

File:

• trunk/wp-admin/includes/file.php (modified) (2 diffs)

trunk/wp-admin/includes/file.php

@@ -535 +535 @@
 }
 
+/**
+ * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the ZipArchive class.
+ * Assumes that WP_Filesystem() has already been called and set up.
+ *
+ * @since 3.0
+ * @see unzip_file
+ * @access private
+ *
+ * @param string $file Full path and filename of zip archive
+ * @param string $to Full path on the filesystem to extract archive to
+ * @param array $needed_dirs A partial list of required folders needed to be created.
+ * @return mixed WP_Error on failure, True on success
+ */
 function _unzip_file_ziparchive($file, $to, $needed_dirs = array()) {
     global $wp_filesystem;
@@ -580 +593 @@
 }
 
+/**
+ * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the PclZip library.
+ * Assumes that WP_Filesystem() has already been called and set up.
+ *
+ * @since 3.0
+ * @see unzip_file
+ * @access private
+ *
+ * @param string $file Full path and filename of zip archive
+ * @param string $to Full path on the filesystem to extract archive to
+ * @param array $needed_dirs A partial list of required folders needed to be created.
+ * @return mixed WP_Error on failure, True on success
+ */
 function _unzip_file_pclzip($file, $to, $needed_dirs = array()) {
     global $wp_filesystem;