3 * Functions for reading, writing, modifying, and deleting files on the file system.
4 * Includes functionality for theme-specific files as well as operations for uploading,
5 * archiving, and rendering output when necessary.
8 * @subpackage Administration
11 /** The descriptions for theme files. */
12 $wp_file_descriptions = array(
13 'index.php' => __( 'Main Index Template' ),
14 'style.css' => __( 'Stylesheet' ),
15 'editor-style.css' => __( 'Visual Editor Stylesheet' ),
16 'editor-style-rtl.css' => __( 'Visual Editor RTL Stylesheet' ),
17 'rtl.css' => __( 'RTL Stylesheet' ),
18 'comments.php' => __( 'Comments' ),
19 'comments-popup.php' => __( 'Popup Comments' ),
20 'footer.php' => __( 'Footer' ),
21 'header.php' => __( 'Header' ),
22 'sidebar.php' => __( 'Sidebar' ),
23 'archive.php' => __( 'Archives' ),
24 'author.php' => __( 'Author Template' ),
25 'tag.php' => __( 'Tag Template' ),
26 'category.php' => __( 'Category Template' ),
27 'page.php' => __( 'Page Template' ),
28 'search.php' => __( 'Search Results' ),
29 'searchform.php' => __( 'Search Form' ),
30 'single.php' => __( 'Single Post' ),
31 '404.php' => __( '404 Template' ),
32 'link.php' => __( 'Links Template' ),
33 'functions.php' => __( 'Theme Functions' ),
34 'attachment.php' => __( 'Attachment Template' ),
35 'image.php' => __('Image Attachment Template'),
36 'video.php' => __('Video Attachment Template'),
37 'audio.php' => __('Audio Attachment Template'),
38 'application.php' => __('Application Attachment Template'),
39 'my-hacks.php' => __( 'my-hacks.php (legacy hacks support)' ),
40 '.htaccess' => __( '.htaccess (for rewrite rules )' ),
42 'wp-layout.css' => __( 'Stylesheet' ),
43 'wp-comments.php' => __( 'Comments Template' ),
44 'wp-comments-popup.php' => __( 'Popup Comments Template' ),
48 * Get the description for standard WordPress theme files and other various standard
53 * @global array $wp_file_descriptions
54 * @param string $file Filesystem path or filename
55 * @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist
57 function get_file_description( $file ) {
58 global $wp_file_descriptions;
60 if ( isset( $wp_file_descriptions[basename( $file )] ) ) {
61 return $wp_file_descriptions[basename( $file )];
63 elseif ( file_exists( $file ) && is_file( $file ) ) {
64 $template_data = implode( '', file( $file ) );
65 if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ))
66 return sprintf( __( '%s Page Template' ), _cleanup_header_comment($name[1]) );
69 return trim( basename( $file ) );
73 * Get the absolute filesystem path to the root of the WordPress installation
77 * @return string Full filesystem path to the root of the WordPress installation
79 function get_home_path() {
80 $home = set_url_scheme( get_option( 'home' ), 'http' );
81 $siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );
82 if ( ! empty( $home ) && 0 !== strcasecmp( $home, $siteurl ) ) {
83 $wp_path_rel_to_home = str_ireplace( $home, '', $siteurl ); /* $siteurl - $home */
84 $pos = strripos( str_replace( '\\', '/', $_SERVER['SCRIPT_FILENAME'] ), trailingslashit( $wp_path_rel_to_home ) );
85 $home_path = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
86 $home_path = trailingslashit( $home_path );
91 return str_replace( '\\', '/', $home_path );
95 * Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
96 * The depth of the recursiveness can be controlled by the $levels param.
100 * @param string $folder Optional. Full path to folder. Default empty.
101 * @param int $levels Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
102 * @return bool|array False on failure, Else array of files
104 function list_files( $folder = '', $levels = 100 ) {
105 if ( empty($folder) )
112 if ( $dir = @opendir( $folder ) ) {
113 while (($file = readdir( $dir ) ) !== false ) {
114 if ( in_array($file, array('.', '..') ) )
116 if ( is_dir( $folder . '/' . $file ) ) {
117 $files2 = list_files( $folder . '/' . $file, $levels - 1);
119 $files = array_merge($files, $files2 );
121 $files[] = $folder . '/' . $file . '/';
123 $files[] = $folder . '/' . $file;
132 * Returns a filename of a Temporary unique file.
133 * Please note that the calling function must unlink() this itself.
135 * The filename is based off the passed parameter or defaults to the current unix timestamp,
136 * while the directory can either be passed as well, or by leaving it blank, default to a writable temporary directory.
140 * @param string $filename Optional. Filename to base the Unique file off. Default empty.
141 * @param string $dir Optional. Directory to store the file in. Default empty.
142 * @return string a writable filename
144 function wp_tempnam( $filename = '', $dir = '' ) {
145 if ( empty( $dir ) ) {
146 $dir = get_temp_dir();
149 if ( empty( $filename ) || '.' == $filename || '/' == $filename ) {
153 // Use the basename of the given file without the extension as the name for the temporary directory
154 $temp_filename = basename( $filename );
155 $temp_filename = preg_replace( '|\.[^.]*$|', '', $temp_filename );
157 // If the folder is falsey, use it's parent directory name instead
158 if ( ! $temp_filename ) {
159 return wp_tempnam( dirname( $filename ), $dir );
162 $temp_filename .= '.tmp';
163 $temp_filename = $dir . wp_unique_filename( $dir, $temp_filename );
164 touch( $temp_filename );
166 return $temp_filename;
170 * Make sure that the file that was requested to edit, is allowed to be edited
172 * Function will die if if you are not allowed to edit the file
176 * @param string $file file the users is attempting to edit
177 * @param array $allowed_files Array of allowed files to edit, $file must match an entry exactly
178 * @return string|null
180 function validate_file_to_edit( $file, $allowed_files = '' ) {
181 $code = validate_file( $file, $allowed_files );
188 wp_die( __( 'Sorry, that file cannot be edited.' ) );
191 // wp_die( __('Sorry, can’t call files with their real path.' ));
194 wp_die( __( 'Sorry, that file cannot be edited.' ) );
199 * Handle PHP uploads in WordPress, sanitizing file names, checking extensions for mime type,
200 * and moving the file to the appropriate directory within the uploads directory.
204 * @see wp_handle_upload_error
206 * @param array $file Reference to a single element of $_FILES. Call the function once for each uploaded file.
207 * @param array|false $overrides An associative array of names => values to override default variables. Default false.
208 * @param string $time Time formatted in 'yyyy/mm'.
209 * @param string $action Expected value for $_POST['action'].
210 * @return array On success, returns an associative array of file attributes. On failure, returns
211 * $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
213 function _wp_handle_upload( &$file, $overrides, $time, $action ) {
214 // The default error handler.
215 if ( ! function_exists( 'wp_handle_upload_error' ) ) {
216 function wp_handle_upload_error( &$file, $message ) {
217 return array( 'error' => $message );
222 * Filter the data for a file before it is uploaded to WordPress.
224 * The dynamic portion of the hook name, `$action`, refers to the post action.
226 * @since 2.9.0 as 'wp_handle_upload_prefilter'.
227 * @since 4.0.0 Converted to a dynamic hook with `$action`.
229 * @param array $file An array of data for a single file.
231 $file = apply_filters( "{$action}_prefilter", $file );
233 // You may define your own function and pass the name in $overrides['upload_error_handler']
234 $upload_error_handler = 'wp_handle_upload_error';
235 if ( isset( $overrides['upload_error_handler'] ) ) {
236 $upload_error_handler = $overrides['upload_error_handler'];
239 // You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully.
240 if ( isset( $file['error'] ) && ! is_numeric( $file['error'] ) && $file['error'] ) {
241 return $upload_error_handler( $file, $file['error'] );
244 // Install user overrides. Did we mention that this voids your warranty?
246 // You may define your own function and pass the name in $overrides['unique_filename_callback']
247 $unique_filename_callback = null;
248 if ( isset( $overrides['unique_filename_callback'] ) ) {
249 $unique_filename_callback = $overrides['unique_filename_callback'];
253 * This may not have orignially been intended to be overrideable,
254 * but historically has been.
256 if ( isset( $overrides['upload_error_strings'] ) ) {
257 $upload_error_strings = $overrides['upload_error_strings'];
259 // Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
260 $upload_error_strings = array(
262 __( 'The uploaded file exceeds the upload_max_filesize directive in php.ini.' ),
263 __( 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.' ),
264 __( 'The uploaded file was only partially uploaded.' ),
265 __( 'No file was uploaded.' ),
267 __( 'Missing a temporary folder.' ),
268 __( 'Failed to write file to disk.' ),
269 __( 'File upload stopped by extension.' )
273 // All tests are on by default. Most can be turned off by $overrides[{test_name}] = false;
274 $test_form = isset( $overrides['test_form'] ) ? $overrides['test_form'] : true;
275 $test_size = isset( $overrides['test_size'] ) ? $overrides['test_size'] : true;
277 // If you override this, you must provide $ext and $type!!
278 $test_type = isset( $overrides['test_type'] ) ? $overrides['test_type'] : true;
279 $mimes = isset( $overrides['mimes'] ) ? $overrides['mimes'] : false;
281 // A correct form post will pass this test.
282 if ( $test_form && ( ! isset( $_POST['action'] ) || ( $_POST['action'] != $action ) ) ) {
283 return call_user_func( $upload_error_handler, $file, __( 'Invalid form submission.' ) );
285 // A successful upload will pass this test. It makes no sense to override this one.
286 if ( isset( $file['error'] ) && $file['error'] > 0 ) {
287 return call_user_func( $upload_error_handler, $file, $upload_error_strings[ $file['error'] ] );
290 $test_file_size = 'wp_handle_upload' === $action ? $file['size'] : filesize( $file['tmp_name'] );
291 // A non-empty file will pass this test.
292 if ( $test_size && ! ( $test_file_size > 0 ) ) {
293 if ( is_multisite() ) {
294 $error_msg = __( 'File is empty. Please upload something more substantial.' );
296 $error_msg = __( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your php.ini or by post_max_size being defined as smaller than upload_max_filesize in php.ini.' );
298 return call_user_func( $upload_error_handler, $file, $error_msg );
301 // A properly uploaded file will pass this test. There should be no reason to override this one.
302 $test_uploaded_file = 'wp_handle_upload' === $action ? @ is_uploaded_file( $file['tmp_name'] ) : @ is_file( $file['tmp_name'] );
303 if ( ! $test_uploaded_file ) {
304 return call_user_func( $upload_error_handler, $file, __( 'Specified file failed upload test.' ) );
307 // A correct MIME type will pass this test. Override $mimes or use the upload_mimes filter.
309 $wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes );
310 $ext = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext'];
311 $type = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type'];
312 $proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename'];
314 // Check to see if wp_check_filetype_and_ext() determined the filename was incorrect
315 if ( $proper_filename ) {
316 $file['name'] = $proper_filename;
318 if ( ( ! $type || !$ext ) && ! current_user_can( 'unfiltered_upload' ) ) {
319 return call_user_func( $upload_error_handler, $file, __( 'Sorry, this file type is not permitted for security reasons.' ) );
322 $type = $file['type'];
329 * A writable uploads dir will pass this test. Again, there's no point
330 * overriding this one.
332 if ( ! ( ( $uploads = wp_upload_dir( $time ) ) && false === $uploads['error'] ) ) {
333 return call_user_func( $upload_error_handler, $file, $uploads['error'] );
336 $filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
338 // Move the file to the uploads dir.
339 $new_file = $uploads['path'] . "/$filename";
340 if ( 'wp_handle_upload' === $action ) {
341 $move_new_file = @ move_uploaded_file( $file['tmp_name'], $new_file );
343 $move_new_file = @ rename( $file['tmp_name'], $new_file );
346 if ( false === $move_new_file ) {
347 if ( 0 === strpos( $uploads['basedir'], ABSPATH ) ) {
348 $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
350 $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
352 return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $error_path ) );
355 // Set correct file permissions.
356 $stat = stat( dirname( $new_file ));
357 $perms = $stat['mode'] & 0000666;
358 @ chmod( $new_file, $perms );
361 $url = $uploads['url'] . "/$filename";
363 if ( is_multisite() ) {
364 delete_transient( 'dirsize_cache' );
368 * Filter the data array for the uploaded file.
372 * @param array $upload {
373 * Array of upload data.
375 * @type string $file Filename of the newly-uploaded file.
376 * @type string $url URL of the uploaded file.
377 * @type string $type File type.
379 * @param string $context The type of upload action. Values include 'upload' or 'sideload'.
381 return apply_filters( 'wp_handle_upload', array(
385 ), 'wp_handle_sideload' === $action ? 'sideload' : 'upload' ); }
388 * Wrapper for _wp_handle_upload(), passes 'wp_handle_upload' action.
392 * @see _wp_handle_upload()
394 * @param array $file Reference to a single element of $_FILES. Call the function once for
395 * each uploaded file.
396 * @param array|bool $overrides Optional. An associative array of names=>values to override default
397 * variables. Default false.
398 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
399 * @return array On success, returns an associative array of file attributes. On failure, returns
400 * $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
402 function wp_handle_upload( &$file, $overrides = false, $time = null ) {
404 * $_POST['action'] must be set and its value must equal $overrides['action']
407 $action = 'wp_handle_upload';
408 if ( isset( $overrides['action'] ) ) {
409 $action = $overrides['action'];
412 return _wp_handle_upload( $file, $overrides, $time, $action );
416 * Wrapper for _wp_handle_upload(), passes 'wp_handle_sideload' action
420 * @see _wp_handle_upload()
422 * @param array $file An array similar to that of a PHP $_FILES POST array
423 * @param array|bool $overrides Optional. An associative array of names=>values to override default
424 * variables. Default false.
425 * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
426 * @return array On success, returns an associative array of file attributes. On failure, returns
427 * $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
429 function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
431 * $_POST['action'] must be set and its value must equal $overrides['action']
434 $action = 'wp_handle_sideload';
435 if ( isset( $overrides['action'] ) ) {
436 $action = $overrides['action'];
438 return _wp_handle_upload( $file, $overrides, $time, $action );
443 * Downloads a url to a local temporary file using the WordPress HTTP Class.
444 * Please note, That the calling function must unlink() the file.
448 * @param string $url the URL of the file to download
449 * @param int $timeout The timeout for the request to download the file default 300 seconds
450 * @return mixed WP_Error on failure, string Filename on success.
452 function download_url( $url, $timeout = 300 ) {
453 //WARNING: The file is not automatically deleted, The script must unlink() the file.
455 return new WP_Error('http_no_url', __('Invalid URL Provided.'));
457 $tmpfname = wp_tempnam($url);
459 return new WP_Error('http_no_file', __('Could not create Temporary file.'));
461 $response = wp_safe_remote_get( $url, array( 'timeout' => $timeout, 'stream' => true, 'filename' => $tmpfname ) );
463 if ( is_wp_error( $response ) ) {
468 if ( 200 != wp_remote_retrieve_response_code( $response ) ){
470 return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ) );
473 $content_md5 = wp_remote_retrieve_header( $response, 'content-md5' );
474 if ( $content_md5 ) {
475 $md5_check = verify_file_md5( $tmpfname, $content_md5 );
476 if ( is_wp_error( $md5_check ) ) {
486 * Calculates and compares the MD5 of a file to its expected value.
490 * @param string $filename The filename to check the MD5 of.
491 * @param string $expected_md5 The expected MD5 of the file, either a base64 encoded raw md5, or a hex-encoded md5
492 * @return bool|object WP_Error on failure, true on success, false when the MD5 format is unknown/unexpected
494 function verify_file_md5( $filename, $expected_md5 ) {
495 if ( 32 == strlen( $expected_md5 ) )
496 $expected_raw_md5 = pack( 'H*', $expected_md5 );
497 elseif ( 24 == strlen( $expected_md5 ) )
498 $expected_raw_md5 = base64_decode( $expected_md5 );
500 return false; // unknown format
502 $file_md5 = md5_file( $filename, true );
504 if ( $file_md5 === $expected_raw_md5 )
507 return new WP_Error( 'md5_mismatch', sprintf( __( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ), bin2hex( $file_md5 ), bin2hex( $expected_raw_md5 ) ) );
511 * Unzips a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction.
512 * Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present.
514 * Attempts to increase the PHP Memory limit to 256M before uncompressing,
515 * However, The most memory required shouldn't be much larger than the Archive itself.
519 * @global WP_Filesystem_Base $wp_filesystem Subclass
521 * @param string $file Full path and filename of zip archive
522 * @param string $to Full path on the filesystem to extract archive to
523 * @return mixed WP_Error on failure, True on success
525 function unzip_file($file, $to) {
526 global $wp_filesystem;
528 if ( ! $wp_filesystem || !is_object($wp_filesystem) )
529 return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
531 // Unzip can use a lot of memory, but not this much hopefully
532 /** This filter is documented in wp-admin/admin.php */
533 @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
535 $needed_dirs = array();
536 $to = trailingslashit($to);
538 // Determine any parent dir's needed (of the upgrade directory)
539 if ( ! $wp_filesystem->is_dir($to) ) { //Only do parents if no children exist
540 $path = preg_split('![/\\\]!', untrailingslashit($to));
541 for ( $i = count($path); $i >= 0; $i-- ) {
542 if ( empty($path[$i]) )
545 $dir = implode('/', array_slice($path, 0, $i+1) );
546 if ( preg_match('!^[a-z]:$!i', $dir) ) // Skip it if it looks like a Windows Drive letter.
549 if ( ! $wp_filesystem->is_dir($dir) )
550 $needed_dirs[] = $dir;
552 break; // A folder exists, therefor, we dont need the check the levels below this
557 * Filter whether to use ZipArchive to unzip archives.
561 * @param bool $ziparchive Whether to use ZipArchive. Default true.
563 if ( class_exists( 'ZipArchive' ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
564 $result = _unzip_file_ziparchive($file, $to, $needed_dirs);
565 if ( true === $result ) {
567 } elseif ( is_wp_error($result) ) {
568 if ( 'incompatible_archive' != $result->get_error_code() )
572 // Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
573 return _unzip_file_pclzip($file, $to, $needed_dirs);
577 * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the ZipArchive class.
578 * Assumes that WP_Filesystem() has already been called and set up.
584 * @global WP_Filesystem_Base $wp_filesystem Subclass
586 * @param string $file Full path and filename of zip archive
587 * @param string $to Full path on the filesystem to extract archive to
588 * @param array $needed_dirs A partial list of required folders needed to be created.
589 * @return mixed WP_Error on failure, True on success
591 function _unzip_file_ziparchive($file, $to, $needed_dirs = array() ) {
592 global $wp_filesystem;
594 $z = new ZipArchive();
596 $zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS );
597 if ( true !== $zopen )
598 return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) );
600 $uncompressed_size = 0;
602 for ( $i = 0; $i < $z->numFiles; $i++ ) {
603 if ( ! $info = $z->statIndex($i) )
604 return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
606 if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Skip the OS X-created __MACOSX directory
609 $uncompressed_size += $info['size'];
611 if ( '/' == substr($info['name'], -1) ) // directory
612 $needed_dirs[] = $to . untrailingslashit($info['name']);
614 $needed_dirs[] = $to . untrailingslashit(dirname($info['name']));
618 * disk_free_space() could return false. Assume that any falsey value is an error.
619 * A disk that has zero free bytes has bigger problems.
620 * Require we have enough space to unzip the file and copy its contents, with a 10% buffer.
622 if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
623 $available_space = @disk_free_space( WP_CONTENT_DIR );
624 if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space )
625 return new WP_Error( 'disk_full_unzip_file', __( 'Could not copy files. You may have run out of disk space.' ), compact( 'uncompressed_size', 'available_space' ) );
628 $needed_dirs = array_unique($needed_dirs);
629 foreach ( $needed_dirs as $dir ) {
630 // Check the parent folders of the folders all exist within the creation array.
631 if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist)
633 if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it
636 $parent_folder = dirname($dir);
637 while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) {
638 $needed_dirs[] = $parent_folder;
639 $parent_folder = dirname($parent_folder);
644 // Create those directories if need be:
645 foreach ( $needed_dirs as $_dir ) {
646 // Only check to see if the Dir exists upon creation failure. Less I/O this way.
647 if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) ) {
648 return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) );
653 for ( $i = 0; $i < $z->numFiles; $i++ ) {
654 if ( ! $info = $z->statIndex($i) )
655 return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
657 if ( '/' == substr($info['name'], -1) ) // directory
660 if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files
663 $contents = $z->getFromIndex($i);
664 if ( false === $contents )
665 return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] );
667 if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE) )
668 return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] );
677 * This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the PclZip library.
678 * Assumes that WP_Filesystem() has already been called and set up.
684 * @global WP_Filesystem_Base $wp_filesystem Subclass
686 * @param string $file Full path and filename of zip archive
687 * @param string $to Full path on the filesystem to extract archive to
688 * @param array $needed_dirs A partial list of required folders needed to be created.
689 * @return mixed WP_Error on failure, True on success
691 function _unzip_file_pclzip($file, $to, $needed_dirs = array()) {
692 global $wp_filesystem;
694 mbstring_binary_safe_encoding();
696 require_once(ABSPATH . 'wp-admin/includes/class-pclzip.php');
698 $archive = new PclZip($file);
700 $archive_files = $archive->extract(PCLZIP_OPT_EXTRACT_AS_STRING);
702 reset_mbstring_encoding();
704 // Is the archive valid?
705 if ( !is_array($archive_files) )
706 return new WP_Error('incompatible_archive', __('Incompatible Archive.'), $archive->errorInfo(true));
708 if ( 0 == count($archive_files) )
709 return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) );
711 $uncompressed_size = 0;
713 // Determine any children directories needed (From within the archive)
714 foreach ( $archive_files as $file ) {
715 if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Skip the OS X-created __MACOSX directory
718 $uncompressed_size += $file['size'];
720 $needed_dirs[] = $to . untrailingslashit( $file['folder'] ? $file['filename'] : dirname($file['filename']) );
724 * disk_free_space() could return false. Assume that any falsey value is an error.
725 * A disk that has zero free bytes has bigger problems.
726 * Require we have enough space to unzip the file and copy its contents, with a 10% buffer.
728 if ( defined( 'DOING_CRON' ) && DOING_CRON ) {
729 $available_space = @disk_free_space( WP_CONTENT_DIR );
730 if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space )
731 return new WP_Error( 'disk_full_unzip_file', __( 'Could not copy files. You may have run out of disk space.' ), compact( 'uncompressed_size', 'available_space' ) );
734 $needed_dirs = array_unique($needed_dirs);
735 foreach ( $needed_dirs as $dir ) {
736 // Check the parent folders of the folders all exist within the creation array.
737 if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist)
739 if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it
742 $parent_folder = dirname($dir);
743 while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) {
744 $needed_dirs[] = $parent_folder;
745 $parent_folder = dirname($parent_folder);
750 // Create those directories if need be:
751 foreach ( $needed_dirs as $_dir ) {
752 // Only check to see if the dir exists upon creation failure. Less I/O this way.
753 if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) )
754 return new WP_Error( 'mkdir_failed_pclzip', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) );
758 // Extract the files from the zip
759 foreach ( $archive_files as $file ) {
760 if ( $file['folder'] )
763 if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files
766 if ( ! $wp_filesystem->put_contents( $to . $file['filename'], $file['content'], FS_CHMOD_FILE) )
767 return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $file['filename'] );
773 * Copies a directory from one location to another via the WordPress Filesystem Abstraction.
774 * Assumes that WP_Filesystem() has already been called and setup.
778 * @global WP_Filesystem_Base $wp_filesystem Subclass
780 * @param string $from source directory
781 * @param string $to destination directory
782 * @param array $skip_list a list of files/folders to skip copying
783 * @return mixed WP_Error on failure, True on success.
785 function copy_dir($from, $to, $skip_list = array() ) {
786 global $wp_filesystem;
788 $dirlist = $wp_filesystem->dirlist($from);
790 $from = trailingslashit($from);
791 $to = trailingslashit($to);
793 foreach ( (array) $dirlist as $filename => $fileinfo ) {
794 if ( in_array( $filename, $skip_list ) )
797 if ( 'f' == $fileinfo['type'] ) {
798 if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) ) {
799 // If copy failed, chmod file to 0644 and try again.
800 $wp_filesystem->chmod( $to . $filename, FS_CHMOD_FILE );
801 if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) )
802 return new WP_Error( 'copy_failed_copy_dir', __( 'Could not copy file.' ), $to . $filename );
804 } elseif ( 'd' == $fileinfo['type'] ) {
805 if ( !$wp_filesystem->is_dir($to . $filename) ) {
806 if ( !$wp_filesystem->mkdir($to . $filename, FS_CHMOD_DIR) )
807 return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename );
810 // generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list
811 $sub_skip_list = array();
812 foreach ( $skip_list as $skip_item ) {
813 if ( 0 === strpos( $skip_item, $filename . '/' ) )
814 $sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
817 $result = copy_dir($from . $filename, $to . $filename, $sub_skip_list);
818 if ( is_wp_error($result) )
826 * Initialises and connects the WordPress Filesystem Abstraction classes.
827 * This function will include the chosen transport and attempt connecting.
829 * Plugins may add extra transports, And force WordPress to use them by returning
830 * the filename via the {@see 'filesystem_method_file'} filter.
834 * @global WP_Filesystem_Base $wp_filesystem Subclass
836 * @param array|false $args Optional. Connection args, These are passed directly to
837 * the `WP_Filesystem_*()` classes. Default false.
838 * @param string|false $context Optional. Context for get_filesystem_method(). Default false.
839 * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
840 * @return null|bool false on failure, true on success.
842 function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) {
843 global $wp_filesystem;
845 require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
847 $method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership );
852 if ( ! class_exists("WP_Filesystem_$method") ) {
855 * Filter the path for a specific filesystem method class file.
859 * @see get_filesystem_method()
861 * @param string $path Path to the specific filesystem method class file.
862 * @param string $method The filesystem method to use.
864 $abstraction_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );
866 if ( ! file_exists($abstraction_file) )
869 require_once($abstraction_file);
871 $method = "WP_Filesystem_$method";
873 $wp_filesystem = new $method($args);
875 //Define the timeouts for the connections. Only available after the construct is called to allow for per-transport overriding of the default.
876 if ( ! defined('FS_CONNECT_TIMEOUT') )
877 define('FS_CONNECT_TIMEOUT', 30);
878 if ( ! defined('FS_TIMEOUT') )
879 define('FS_TIMEOUT', 30);
881 if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
884 if ( !$wp_filesystem->connect() )
885 return false; //There was an error connecting to the server.
887 // Set the permission constants if not already set.
888 if ( ! defined('FS_CHMOD_DIR') )
889 define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
890 if ( ! defined('FS_CHMOD_FILE') )
891 define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
897 * Determines which method to use for reading, writing, modifying, or deleting
898 * files on the filesystem.
900 * The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets
901 * (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2',
902 * 'ftpext' or 'ftpsockets'.
904 * The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
905 * or filtering via {@see 'filesystem_method'}.
907 * @link https://codex.wordpress.org/Editing_wp-config.php#WordPress_Upgrade_Constants
909 * Plugins may define a custom transport handler, See WP_Filesystem().
913 * @global callback $_wp_filesystem_direct_method
915 * @param array $args Optional. Connection details. Default empty array.
916 * @param string $context Optional. Full path to the directory that is tested
917 * for being writable. Default false.
918 * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
920 * @return string The transport to use, see description for valid return values.
922 function get_filesystem_method( $args = array(), $context = false, $allow_relaxed_file_ownership = false ) {
923 $method = defined('FS_METHOD') ? FS_METHOD : false; // Please ensure that this is either 'direct', 'ssh2', 'ftpext' or 'ftpsockets'
926 $context = WP_CONTENT_DIR;
929 // If the directory doesn't exist (wp-content/languages) then use the parent directory as we'll create it.
930 if ( WP_LANG_DIR == $context && ! is_dir( $context ) ) {
931 $context = dirname( $context );
934 $context = trailingslashit( $context );
938 $temp_file_name = $context . 'temp-write-test-' . time();
939 $temp_handle = @fopen($temp_file_name, 'w');
940 if ( $temp_handle ) {
942 // Attempt to determine the file owner of the WordPress files, and that of newly created files
943 $wp_file_owner = $temp_file_owner = false;
944 if ( function_exists('fileowner') ) {
945 $wp_file_owner = @fileowner( __FILE__ );
946 $temp_file_owner = @fileowner( $temp_file_name );
949 if ( $wp_file_owner !== false && $wp_file_owner === $temp_file_owner ) {
950 // WordPress is creating files as the same owner as the WordPress files,
951 // this means it's safe to modify & create new files via PHP.
953 $GLOBALS['_wp_filesystem_direct_method'] = 'file_owner';
954 } elseif ( $allow_relaxed_file_ownership ) {
955 // The $context directory is writable, and $allow_relaxed_file_ownership is set, this means we can modify files
956 // safely in this directory. This mode doesn't create new files, only alter existing ones.
958 $GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
961 @fclose($temp_handle);
962 @unlink($temp_file_name);
966 if ( ! $method && isset($args['connection_type']) && 'ssh' == $args['connection_type'] && extension_loaded('ssh2') && function_exists('stream_get_contents') ) $method = 'ssh2';
967 if ( ! $method && extension_loaded('ftp') ) $method = 'ftpext';
968 if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread
971 * Filter the filesystem method to use.
975 * @param string $method Filesystem method to return.
976 * @param array $args An array of connection details for the method.
977 * @param string $context Full path to the directory that is tested for being writable.
978 * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
980 return apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership );
984 * Displays a form to the user to request for their FTP/SSH details in order
985 * to connect to the filesystem.
987 * All chosen/entered details are saved, Excluding the Password.
989 * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
990 * to specify an alternate FTP/SSH port.
992 * Plugins may override this form by returning true|false via the
993 * {@see 'request_filesystem_credentials'} filter.
997 * @todo Properly mark optional arguments as such
999 * @param string $form_post the URL to post the form to
1000 * @param string $type the chosen Filesystem method in use
1001 * @param bool $error if the current request has failed to connect
1002 * @param string $context The directory which is needed access to, The write-test will be performed on this directory by get_filesystem_method()
1003 * @param array $extra_fields Extra POST fields which should be checked for to be included in the post.
1004 * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
1005 * @return bool False on failure. True on success.
1007 function request_filesystem_credentials($form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) {
1010 * Filter the filesystem credentials form output.
1012 * Returning anything other than an empty string will effectively short-circuit
1013 * output of the filesystem credentials form, returning that value instead.
1017 * @param mixed $output Form output to return instead. Default empty.
1018 * @param string $form_post URL to POST the form to.
1019 * @param string $type Chosen type of filesystem.
1020 * @param bool $error Whether the current request has failed to connect.
1022 * @param string $context Full path to the directory that is tested for
1024 * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
1025 * @param array $extra_fields Extra POST fields.
1027 $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
1028 if ( '' !== $req_cred )
1031 if ( empty($type) ) {
1032 $type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
1035 if ( 'direct' == $type )
1038 if ( is_null( $extra_fields ) )
1039 $extra_fields = array( 'version', 'locale' );
1041 $credentials = get_option('ftp_credentials', array( 'hostname' => '', 'username' => ''));
1043 // If defined, set it to that, Else, If POST'd, set it to that, If not, Set it to whatever it previously was(saved details in option)
1044 $credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : (!empty($_POST['hostname']) ? wp_unslash( $_POST['hostname'] ) : $credentials['hostname']);
1045 $credentials['username'] = defined('FTP_USER') ? FTP_USER : (!empty($_POST['username']) ? wp_unslash( $_POST['username'] ) : $credentials['username']);
1046 $credentials['password'] = defined('FTP_PASS') ? FTP_PASS : (!empty($_POST['password']) ? wp_unslash( $_POST['password'] ) : '');
1048 // Check to see if we are setting the public/private keys for ssh
1049 $credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : (!empty($_POST['public_key']) ? wp_unslash( $_POST['public_key'] ) : '');
1050 $credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : (!empty($_POST['private_key']) ? wp_unslash( $_POST['private_key'] ) : '');
1052 // Sanitize the hostname, Some people might pass in odd-data:
1053 $credentials['hostname'] = preg_replace('|\w+://|', '', $credentials['hostname']); //Strip any schemes off
1055 if ( strpos($credentials['hostname'], ':') ) {
1056 list( $credentials['hostname'], $credentials['port'] ) = explode(':', $credentials['hostname'], 2);
1057 if ( ! is_numeric($credentials['port']) )
1058 unset($credentials['port']);
1060 unset($credentials['port']);
1063 if ( ( defined( 'FTP_SSH' ) && FTP_SSH ) || ( defined( 'FS_METHOD' ) && 'ssh2' == FS_METHOD ) ) {
1064 $credentials['connection_type'] = 'ssh';
1065 } elseif ( ( defined( 'FTP_SSL' ) && FTP_SSL ) && 'ftpext' == $type ) { //Only the FTP Extension understands SSL
1066 $credentials['connection_type'] = 'ftps';
1067 } elseif ( ! empty( $_POST['connection_type'] ) ) {
1068 $credentials['connection_type'] = wp_unslash( $_POST['connection_type'] );
1069 } elseif ( ! isset( $credentials['connection_type'] ) ) { //All else fails (And it's not defaulted to something else saved), Default to FTP
1070 $credentials['connection_type'] = 'ftp';
1074 ( !empty($credentials['password']) && !empty($credentials['username']) && !empty($credentials['hostname']) ) ||
1075 ( 'ssh' == $credentials['connection_type'] && !empty($credentials['public_key']) && !empty($credentials['private_key']) )
1077 $stored_credentials = $credentials;
1078 if ( !empty($stored_credentials['port']) ) //save port as part of hostname to simplify above code.
1079 $stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
1081 unset($stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key']);
1082 if ( ! defined( 'WP_INSTALLING' ) ) {
1083 update_option( 'ftp_credentials', $stored_credentials );
1085 return $credentials;
1087 $hostname = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
1088 $username = isset( $credentials['username'] ) ? $credentials['username'] : '';
1089 $public_key = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
1090 $private_key = isset( $credentials['private_key'] ) ? $credentials['private_key'] : '';
1091 $port = isset( $credentials['port'] ) ? $credentials['port'] : '';
1092 $connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : '';
1095 $error_string = __('<strong>ERROR:</strong> There was an error connecting to the server, Please verify the settings are correct.');
1096 if ( is_wp_error($error) )
1097 $error_string = esc_html( $error->get_error_message() );
1098 echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';
1102 if ( extension_loaded('ftp') || extension_loaded('sockets') || function_exists('fsockopen') )
1103 $types[ 'ftp' ] = __('FTP');
1104 if ( extension_loaded('ftp') ) //Only this supports FTPS
1105 $types[ 'ftps' ] = __('FTPS (SSL)');
1106 if ( extension_loaded('ssh2') && function_exists('stream_get_contents') )
1107 $types[ 'ssh' ] = __('SSH2');
1110 * Filter the connection types to output to the filesystem credentials form.
1114 * @param array $types Types of connections.
1115 * @param array $credentials Credentials to connect with.
1116 * @param string $type Chosen filesystem method.
1117 * @param object $error Error object.
1118 * @param string $context Full path to the directory that is tested
1119 * for being writable.
1121 $types = apply_filters( 'fs_ftp_connection_types', $types, $credentials, $type, $error, $context );
1124 <script type="text/javascript">
1127 jQuery("#ssh").click(function () {
1128 jQuery("#ssh_keys").show();
1130 jQuery("#ftp, #ftps").click(function () {
1131 jQuery("#ssh_keys").hide();
1133 jQuery('#request-filesystem-credentials-form input[value=""]:first').focus();
1137 <form action="<?php echo esc_url( $form_post ) ?>" method="post">
1138 <div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form">
1139 <h3 id="request-filesystem-credentials-title"><?php _e( 'Connection Information' ) ?></h3>
1140 <p id="request-filesystem-credentials-desc"><?php
1141 $label_user = __('Username');
1142 $label_pass = __('Password');
1143 _e('To perform the requested action, WordPress needs to access your web server.');
1145 if ( ( isset( $types['ftp'] ) || isset( $types['ftps'] ) ) ) {
1146 if ( isset( $types['ssh'] ) ) {
1147 _e('Please enter your FTP or SSH credentials to proceed.');
1148 $label_user = __('FTP/SSH Username');
1149 $label_pass = __('FTP/SSH Password');
1151 _e('Please enter your FTP credentials to proceed.');
1152 $label_user = __('FTP Username');
1153 $label_pass = __('FTP Password');
1157 _e('If you do not remember your credentials, you should contact your web host.');
1159 <label for="hostname">
1160 <span class="field-title"><?php _e( 'Hostname' ) ?></span>
1161 <input name="hostname" type="text" id="hostname" aria-describedby="request-filesystem-credentials-desc" class="code" placeholder="<?php esc_attr_e( 'example: www.wordpress.org' ) ?>" value="<?php echo esc_attr($hostname); if ( !empty($port) ) echo ":$port"; ?>"<?php disabled( defined('FTP_HOST') ); ?> />
1163 <div class="ftp-username">
1164 <label for="username">
1165 <span class="field-title"><?php echo $label_user; ?></span>
1166 <input name="username" type="text" id="username" value="<?php echo esc_attr($username) ?>"<?php disabled( defined('FTP_USER') ); ?> />
1169 <div class="ftp-password">
1170 <label for="password">
1171 <span class="field-title"><?php echo $label_pass; ?></span>
1172 <input name="password" type="password" id="password" value="<?php if ( defined('FTP_PASS') ) echo '*****'; ?>"<?php disabled( defined('FTP_PASS') ); ?> />
1173 <em><?php if ( ! defined('FTP_PASS') ) _e( 'This password will not be stored on the server.' ); ?></em>
1176 <?php if ( isset($types['ssh']) ) : ?>
1177 <h4><?php _e('Authentication Keys') ?></h4>
1178 <label for="public_key">
1179 <span class="field-title"><?php _e('Public Key:') ?></span>
1180 <input name="public_key" type="text" id="public_key" aria-describedby="auth-keys-desc" value="<?php echo esc_attr($public_key) ?>"<?php disabled( defined('FTP_PUBKEY') ); ?> />
1182 <label for="private_key">
1183 <span class="field-title"><?php _e('Private Key:') ?></span>
1184 <input name="private_key" type="text" id="private_key" value="<?php echo esc_attr($private_key) ?>"<?php disabled( defined('FTP_PRIKEY') ); ?> />
1186 <span id="auth-keys-desc"><?php _e('Enter the location on the server where the public and private keys are located. If a passphrase is needed, enter that in the password field above.') ?></span>
1188 <h4><?php _e('Connection Type') ?></h4>
1189 <fieldset><legend class="screen-reader-text"><span><?php _e('Connection Type') ?></span></legend>
1191 $disabled = disabled( (defined('FTP_SSL') && FTP_SSL) || (defined('FTP_SSH') && FTP_SSH), true, false );
1192 foreach ( $types as $name => $text ) : ?>
1193 <label for="<?php echo esc_attr($name) ?>">
1194 <input type="radio" name="connection_type" id="<?php echo esc_attr($name) ?>" value="<?php echo esc_attr($name) ?>"<?php checked($name, $connection_type); echo $disabled; ?> />
1197 <?php endforeach; ?>
1200 foreach ( (array) $extra_fields as $field ) {
1201 if ( isset( $_POST[ $field ] ) )
1202 echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( wp_unslash( $_POST[ $field ] ) ) . '" />';
1205 <p class="request-filesystem-credentials-action-buttons">
1206 <button class="button cancel-button" data-js-action="close" type="button"><?php _e( 'Cancel' ); ?></button>
1207 <?php submit_button( __( 'Proceed' ), 'button', 'upgrade', false ); ?>
1216 * Print the filesystem credentials modal when needed.
1220 function wp_print_request_filesystem_credentials_modal() {
1221 $filesystem_method = get_filesystem_method();
1223 $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1225 $request_filesystem_credentials = ( $filesystem_method != 'direct' && ! $filesystem_credentials_are_stored );
1226 if ( ! $request_filesystem_credentials ) {
1230 <div id="request-filesystem-credentials-dialog" class="notification-dialog-wrap request-filesystem-credentials-dialog">
1231 <div class="notification-dialog-background"></div>
1232 <div class="notification-dialog" role="dialog" aria-labelledby="request-filesystem-credentials-title" tabindex="0">
1233 <div class="request-filesystem-credentials-dialog-content">
1234 <?php request_filesystem_credentials( site_url() ); ?>