enmi-conf.org: comparison wp/wp-admin/includes/file.php

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
 	// Content
 	'singular.php'          => __( 'Singular Template' ),
 	'single.php'            => __( 'Single Post' ),
 	'page.php'              => __( 'Single Page' ),
 	'front-page.php'        => __( 'Homepage' ),
+	'privacy-policy.php'    => __( 'Privacy Policy Page' ),
 	// Attachments
 	'attachment.php'        => __( 'Attachment Template' ),
 	'image.php'             => __( 'Image Attachment Template' ),
 	'video.php'             => __( 'Video Attachment Template' ),
 	'audio.php'             => __( 'Audio Attachment Template' ),
 function get_home_path() {
 	$home    = set_url_scheme( get_option( 'home' ), 'http' );
 	$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );
 	if ( ! empty( $home ) && 0 !== strcasecmp( $home, $siteurl ) ) {
 		$wp_path_rel_to_home = str_ireplace( $home, '', $siteurl ); /* $siteurl - $home */
-		$pos = strripos( str_replace( '\\', '/', $_SERVER['SCRIPT_FILENAME'] ), trailingslashit( $wp_path_rel_to_home ) );
+		$pos                 = strripos( str_replace( '\\', '/', $_SERVER['SCRIPT_FILENAME'] ), trailingslashit( $wp_path_rel_to_home ) );
-		$home_path = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
+		$home_path           = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
-		$home_path = trailingslashit( $home_path );
+		$home_path           = trailingslashit( $home_path );
 	} else {
 		$home_path = ABSPATH;
 	}
 	return str_replace( '\\', '/', $home_path );
 * The depth of the recursiveness can be controlled by the $levels param.
 *
 * @since 2.6.0
 * @since 4.9.0 Added the `$exclusions` parameter.
 *
-* @param string $folder Optional. Full path to folder. Default empty.
+* @param string   $folder     Optional. Full path to folder. Default empty.
-* @param int    $levels Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
+* @param int      $levels     Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
-* @param array  $exclusions Optional. List of folders and files to skip.
+* @param string[] $exclusions Optional. List of folders and files to skip.
-* @return bool|array False on failure, Else array of files
+* @return bool|string[] False on failure, else array of files.
 */
 function list_files( $folder = '', $levels = 100, $exclusions = array() ) {
 	if ( empty( $folder ) ) {
 		return false;
 	}
 			}
 			if ( is_dir( $folder . $file ) ) {
 				$files2 = list_files( $folder . $file, $levels - 1 );
 				if ( $files2 ) {
-					$files = array_merge($files, $files2 );
+					$files = array_merge( $files, $files2 );
 				} else {
 					$files[] = $folder . $file . '/';
 				}
 			} else {
 				$files[] = $folder . $file;
 /**
 * Get list of file extensions that are editable in plugins.
 *
 * @since 4.9.0
 *
-* @param string $plugin Plugin.
+* @param string $plugin Path to the plugin file relative to the plugins directory.
-* @return array File extensions.
+* @return string[] Array of editable file extensions.
 */
 function wp_get_plugin_file_editable_extensions( $plugin ) {
 	$editable_extensions = array(
 		'bash',
 	/**
 	 * Filters file type extensions editable in the plugin editor.
 	 *
 	 * @since 2.8.0
-	 * @since 4.9.0 Adds $plugin param.
+	 * @since 4.9.0 Added the `$plugin` parameter.
 	 *
-	 * @param string $plugin Plugin file.
+	 * @param string[] $editable_extensions An array of editable plugin file extensions.
-	 * @param array $editable_extensions An array of editable plugin file extensions.
+	 * @param string   $plugin              Path to the plugin file relative to the plugins directory.
 	 */
 	$editable_extensions = (array) apply_filters( 'editable_extensions', $editable_extensions, $plugin );
 	return $editable_extensions;
 }
 /**
 * Get list of file extensions that are editable for a given theme.
 *
-* @param WP_Theme $theme Theme.
+* @param WP_Theme $theme Theme object.
-* @return array File extensions.
+* @return string[] Array of editable file extensions.
 */
 function wp_get_theme_file_editable_extensions( $theme ) {
 	$default_types = array(
 		'bash',
 	/**
 	 * Filters the list of file types allowed for editing in the Theme editor.
 	 *
 	 * @since 4.4.0
 	 *
-	 * @param array    $default_types List of file types. Default types include 'php' and 'css'.
+	 * @param string[] $default_types List of allowed file types.
 	 * @param WP_Theme $theme         The current Theme object.
 	 */
 	$file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme );
 	// Ensure that default types are still there.
 		<div class="notice inline notice-{{ data.type || 'info' }} {{ data.alt ? 'notice-alt' : '' }} {{ data.dismissible ? 'is-dismissible' : '' }} {{ data.classes || '' }}">
 			<# if ( 'php_error' === data.code ) { #>
 				<p>
 					<?php
 					printf(
-						/* translators: %$1s is line number and %1$s is file path. */
+						/* translators: 1: line number, 2: file path */
 						__( 'Your PHP code changes were rolled back due to an error on line %1$s of file %2$s. Please fix and try saving again.' ),
 						'{{ data.line }}',
 						'{{ data.file }}'
 					);
 					?>
 * to attempt to see if there is a fatal error introduced. If so, the PHP change will be
 * reverted.
 *
 * @since 4.9.0
 *
-* @param array $args {
+* @param string[] $args {
 *     Args. Note that all of the arg values are already unslashed. They are, however,
-*     coming straight from $_POST and are not validated or sanitized in any way.
+*     coming straight from `$_POST` and are not validated or sanitized in any way.
 *
 *     @type string $file       Relative path to file.
-*     @type string $plugin     Plugin being edited.
+*     @type string $plugin     Path to the plugin file relative to the plugins directory.
 *     @type string $theme      Theme being edited.
 *     @type string $newcontent New content for the file.
 *     @type string $nonce      Nonce.
 * }
 * @return true|WP_Error True on success or `WP_Error` on failure.
 	if ( ! isset( $args['nonce'] ) ) {
 		return new WP_Error( 'missing_nonce' );
 	}
-	$plugin = null;
+	$plugin    = null;
-	$theme = null;
+	$theme     = null;
 	$real_file = null;
 	if ( ! empty( $args['plugin'] ) ) {
 		$plugin = $args['plugin'];
 		if ( ! current_user_can( 'edit_plugins' ) ) {
 		$theme = wp_get_theme( $stylesheet );
 		if ( ! $theme->exists() ) {
 			return new WP_Error( 'non_existent_theme', __( 'The requested theme does not exist.' ) );
 		}
-		$real_file = $theme->get_stylesheet_directory() . '/' . $file;
+		if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) {
-		if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $real_file . $stylesheet ) ) {
 			return new WP_Error( 'nonce_failure' );
 		}
 		if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) {
 			return new WP_Error(
 			switch ( $type ) {
 				case 'php':
 					$allowed_files = array_merge( $allowed_files, $theme->get_files( 'php', -1 ) );
 					break;
 				case 'css':
-					$style_files = $theme->get_files( 'css', -1 );
+					$style_files                = $theme->get_files( 'css', -1 );
 					$allowed_files['style.css'] = $style_files['style.css'];
-					$allowed_files = array_merge( $allowed_files, $style_files );
+					$allowed_files              = array_merge( $allowed_files, $style_files );
 					break;
 				default:
 					$allowed_files = array_merge( $allowed_files, $theme->get_files( $type, -1 ) );
 					break;
 			}
 		// Compare based on relative paths
 		if ( 0 !== validate_file( $file, array_keys( $allowed_files ) ) ) {
 			return new WP_Error( 'disallowed_theme_file', __( 'Sorry, that file cannot be edited.' ) );
 		}
+		$real_file = $theme->get_stylesheet_directory() . '/' . $file;
 		$is_active = ( get_stylesheet() === $stylesheet || get_template() === $stylesheet );
 	} else {
 		return new WP_Error( 'missing_theme_or_plugin' );
 	}
 	// Ensure file is real.
 		opcache_invalidate( $real_file, true );
 	}
 	if ( $is_active && 'php' === $extension ) {
-		$scrape_key = md5( rand() );
+		$scrape_key   = md5( rand() );
-		$transient = 'scrape_key_' . $scrape_key;
+		$transient    = 'scrape_key_' . $scrape_key;
 		$scrape_nonce = strval( rand() );
 		set_transient( $transient, $scrape_nonce, 60 ); // It shouldn't take more than 60 seconds to make the two loopback requests.
-		$cookies = wp_unslash( $_COOKIE );
+		$cookies       = wp_unslash( $_COOKIE );
 		$scrape_params = array(
-			'wp_scrape_key' => $scrape_key,
+			'wp_scrape_key'   => $scrape_key,
 			'wp_scrape_nonce' => $scrape_nonce,
 		);
-		$headers = array(
+		$headers       = array(
 			'Cache-Control' => 'no-cache',
 		);
 		// Include Basic auth in loopback requests.
 		if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
 		// Time to wait for loopback requests to finish.
 		$timeout = 100;
 		$needle_start = "###### wp_scraping_result_start:$scrape_key ######";
-		$needle_end = "###### wp_scraping_result_end:$scrape_key ######";
+		$needle_end   = "###### wp_scraping_result_end:$scrape_key ######";
 		// Attempt loopback request to editor to see if user just whitescreened themselves.
 		if ( $plugin ) {
 			$url = add_query_arg( compact( 'plugin', 'file' ), admin_url( 'plugin-editor.php' ) );
 		} elseif ( isset( $stylesheet ) ) {
 			$url = add_query_arg(
 				array(
 					'theme' => $stylesheet,
-					'file' => $file,
+					'file'  => $file,
 				),
 				admin_url( 'theme-editor.php' )
 			);
 		} else {
 			$url = admin_url();
 		}
-		$url = add_query_arg( $scrape_params, $url );
+		$url                    = add_query_arg( $scrape_params, $url );
-		$r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
+		$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
-		$body = wp_remote_retrieve_body( $r );
+		$body                   = wp_remote_retrieve_body( $r );
 		$scrape_result_position = strpos( $body, $needle_start );
 		$loopback_request_failure = array(
-			'code' => 'loopback_request_failed',
+			'code'    => 'loopback_request_failed',
 			'message' => __( 'Unable to communicate back with site to check for fatal errors, so the PHP change was reverted. You will need to upload your PHP file change by some other means, such as by using SFTP.' ),
 		);
-		$json_parse_failure = array(
+		$json_parse_failure       = array(
 			'code' => 'json_parse_error',
 		);
 		$result = null;
 		if ( false === $scrape_result_position ) {
 			$result = $loopback_request_failure;
 		} else {
 			$error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) );
 			$error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) );
-			$result = json_decode( trim( $error_output ), true );
+			$result       = json_decode( trim( $error_output ), true );
 			if ( empty( $result ) ) {
 				$result = $json_parse_failure;
 			}
 		}
 		// Try making request to homepage as well to see if visitors have been whitescreened.
 		if ( true === $result ) {
-			$url = home_url( '/' );
+			$url                    = home_url( '/' );
-			$url = add_query_arg( $scrape_params, $url );
+			$url                    = add_query_arg( $scrape_params, $url );
-			$r = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
+			$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout' ) );
-			$body = wp_remote_retrieve_body( $r );
+			$body                   = wp_remote_retrieve_body( $r );
 			$scrape_result_position = strpos( $body, $needle_start );
 			if ( false === $scrape_result_position ) {
 				$result = $loopback_request_failure;
 			} else {
 				$error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) );
 				$error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) );
-				$result = json_decode( trim( $error_output ), true );
+				$result       = json_decode( trim( $error_output ), true );
 				if ( empty( $result ) ) {
 					$result = $json_parse_failure;
 				}
 			}
 		}
 	if ( empty( $dir ) ) {
 		$dir = get_temp_dir();
 	}
 	if ( empty( $filename ) || '.' == $filename || '/' == $filename || '\\' == $filename ) {
-		$filename = time();
+		$filename = uniqid();
 	}
 	// Use the basename of the given file without the extension as the name for the temporary directory
 	$temp_filename = basename( $filename );
 	$temp_filename = preg_replace( '|\.[^.]*$|', '', $temp_filename );
 	}
 	// Suffix some random data to avoid filename conflicts
 	$temp_filename .= '-' . wp_generate_password( 6, false );
 	$temp_filename .= '.tmp';
-	$temp_filename = $dir . wp_unique_filename( $dir, $temp_filename );
+	$temp_filename  = $dir . wp_unique_filename( $dir, $temp_filename );
 	$fp = @fopen( $temp_filename, 'x' );
 	if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) {
 		return wp_tempnam( $filename, $dir );
 	}
 *
 * Function will die if you are not allowed to edit the file.
 *
 * @since 1.5.0
 *
-* @param string $file          File the user is attempting to edit.
+* @param string   $file          File the user is attempting to edit.
-* @param array  $allowed_files Optional. Array of allowed files to edit, $file must match an entry exactly.
+* @param string[] $allowed_files Optional. Array of allowed files to edit. `$file` must match an entry exactly.
-* @return string|null
+* @return string|void Returns the file name on success, dies on failure.
 */
 function validate_file_to_edit( $file, $allowed_files = array() ) {
 	$code = validate_file( $file, $allowed_files );
-	if (!$code )
+	if ( ! $code ) {
 		return $file;
+	}
 	switch ( $code ) {
-		case 1 :
+		case 1:
 			wp_die( __( 'Sorry, that file cannot be edited.' ) );
-		// case 2 :
+			// case 2 :
-		// wp_die( __('Sorry, can&#8217;t call files with their real path.' ));
+			// wp_die( __('Sorry, can&#8217;t call files with their real path.' ));
-		case 3 :
+		case 3:
 			wp_die( __( 'Sorry, that file cannot be edited.' ) );
 	}
 }
 /**
 * @access private
 * @since 4.0.0
 *
 * @see wp_handle_upload_error
 *
-* @param array       $file      Reference to a single element of $_FILES. Call the function once for each uploaded file.
+* @param string[]       $file      Reference to a single element of `$_FILES`. Call the function once for each uploaded file.
-* @param array|false $overrides An associative array of names => values to override default variables. Default false.
+* @param string[]|false $overrides An associative array of names => values to override default variables. Default false.
-* @param string      $time      Time formatted in 'yyyy/mm'.
+* @param string         $time      Time formatted in 'yyyy/mm'.
-* @param string      $action    Expected value for $_POST['action'].
+* @param string         $action    Expected value for `$_POST['action']`.
-* @return array On success, returns an associative array of file attributes. On failure, returns
+* @return string[] On success, returns an associative array of file attributes. On failure, returns
-*               $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
+*               `$overrides['upload_error_handler'](&$file, $message )` or `array( 'error'=>$message )`.
 */
 function _wp_handle_upload( &$file, $overrides, $time, $action ) {
 	// The default error handler.
 	if ( ! function_exists( 'wp_handle_upload_error' ) ) {
 		function wp_handle_upload_error( &$file, $message ) {
 	 * The dynamic portion of the hook name, `$action`, refers to the post action.
 	 *
 	 * @since 2.9.0 as 'wp_handle_upload_prefilter'.
 	 * @since 4.0.0 Converted to a dynamic hook with `$action`.
 	 *
-	 * @param array $file An array of data for a single file.
+	 * @param string[] $file An array of data for a single file.
 	 */
 	$file = apply_filters( "{$action}_prefilter", $file );
 	// You may define your own function and pass the name in $overrides['upload_error_handler']
 	$upload_error_handler = 'wp_handle_upload_error';
 			__( 'The uploaded file was only partially uploaded.' ),
 			__( 'No file was uploaded.' ),
 			'',
 			__( 'Missing a temporary folder.' ),
 			__( 'Failed to write file to disk.' ),
-			__( 'File upload stopped by extension.' )
+			__( 'File upload stopped by extension.' ),
 		);
 	}
 	// All tests are on by default. Most can be turned off by $overrides[{test_name}] = false;
 	$test_form = isset( $overrides['test_form'] ) ? $overrides['test_form'] : true;
 	$test_size = isset( $overrides['test_size'] ) ? $overrides['test_size'] : true;
 	// If you override this, you must provide $ext and $type!!
 	$test_type = isset( $overrides['test_type'] ) ? $overrides['test_type'] : true;
-	$mimes = isset( $overrides['mimes'] ) ? $overrides['mimes'] : false;
+	$mimes     = isset( $overrides['mimes'] ) ? $overrides['mimes'] : false;
 	// A correct form post will pass this test.
 	if ( $test_form && ( ! isset( $_POST['action'] ) || ( $_POST['action'] != $action ) ) ) {
 		return call_user_func_array( $upload_error_handler, array( &$file, __( 'Invalid form submission.' ) ) );
 	}
 	// A successful upload will pass this test. It makes no sense to override this one.
 	if ( isset( $file['error'] ) && $file['error'] > 0 ) {
 		return call_user_func_array( $upload_error_handler, array( &$file, $upload_error_strings[ $file['error'] ] ) );
+	}
+	// A properly uploaded file will pass this test. There should be no reason to override this one.
+	$test_uploaded_file = 'wp_handle_upload' === $action ? @ is_uploaded_file( $file['tmp_name'] ) : @ is_readable( $file['tmp_name'] );
+	if ( ! $test_uploaded_file ) {
+		return call_user_func_array( $upload_error_handler, array( &$file, __( 'Specified file failed upload test.' ) ) );
 	}
 	$test_file_size = 'wp_handle_upload' === $action ? $file['size'] : filesize( $file['tmp_name'] );
 	// A non-empty file will pass this test.
 	if ( $test_size && ! ( $test_file_size > 0 ) ) {
 			$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.' );
 		}
 		return call_user_func_array( $upload_error_handler, array( &$file, $error_msg ) );
 	}
-	// A properly uploaded file will pass this test. There should be no reason to override this one.
-	$test_uploaded_file = 'wp_handle_upload' === $action ? @ is_uploaded_file( $file['tmp_name'] ) : @ is_file( $file['tmp_name'] );
-	if ( ! $test_uploaded_file ) {
-		return call_user_func_array( $upload_error_handler, array( &$file, __( 'Specified file failed upload test.' ) ) );
-	}
 	// A correct MIME type will pass this test. Override $mimes or use the upload_mimes filter.
 	if ( $test_type ) {
-		$wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes );
+		$wp_filetype     = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes );
-		$ext = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext'];
+		$ext             = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext'];
-		$type = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type'];
+		$type            = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type'];
 		$proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename'];
 		// Check to see if wp_check_filetype_and_ext() determined the filename was incorrect
 		if ( $proper_filename ) {
 			$file['name'] = $proper_filename;
 		}
-		if ( ( ! $type || !$ext ) && ! current_user_can( 'unfiltered_upload' ) ) {
+		if ( ( ! $type || ! $ext ) && ! current_user_can( 'unfiltered_upload' ) ) {
 			return call_user_func_array( $upload_error_handler, array( &$file, __( 'Sorry, this file type is not permitted for security reasons.' ) ) );
 		}
 		if ( ! $type ) {
 			$type = $file['type'];
 		}
 	$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
 	// Move the file to the uploads dir.
 	$new_file = $uploads['path'] . "/$filename";
 	/**
 	 * Filters whether to short-circuit moving the uploaded file after passing all checks.
 	 *
 	 * If a non-null value is passed to the filter, moving the file and any related error
 	 * reporting will be completely skipped.
 	 *
 			if ( 0 === strpos( $uploads['basedir'], ABSPATH ) ) {
 				$error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
 			} else {
 				$error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
 			}
-			return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $error_path ) );
+			return $upload_error_handler( $file, sprintf( __( 'The uploaded file could not be moved to %s.' ), $error_path ) );
 		}
 	}
 	// Set correct file permissions.
-	$stat = stat( dirname( $new_file ));
+	$stat  = stat( dirname( $new_file ) );
 	$perms = $stat['mode'] & 0000666;
 	@ chmod( $new_file, $perms );
 	// Compute the URL.
 	$url = $uploads['url'] . "/$filename";
 	 *     @type string $url  URL of the uploaded file.
 	 *     @type string $type File type.
 	 * }
 	 * @param string $context The type of upload action. Values include 'upload' or 'sideload'.
 	 */
-	return apply_filters( 'wp_handle_upload', array(
+	return apply_filters(
-		'file' => $new_file,
+		'wp_handle_upload',
-		'url'  => $url,
+		array(
-		'type' => $type
+			'file' => $new_file,
-	), 'wp_handle_sideload' === $action ? 'sideload' : 'upload' );
+			'url'  => $url,
+			'type' => $type,
+		),
+		'wp_handle_sideload' === $action ? 'sideload' : 'upload'
+	);
 }
 /**
 * Wrapper for _wp_handle_upload().
 *
 	return _wp_handle_upload( $file, $overrides, $time, $action );
 }
 /**
-* Downloads a URL to a local temporary file using the WordPress HTTP Class.
+* Downloads a URL to a local temporary file using the WordPress HTTP API.
-* Please note, That the calling function must unlink() the file.
+*
+* Please note that the calling function must unlink() the file.
 *
 * @since 2.5.0
-*
+* @since 5.2.0 Signature Verification with SoftFail was added.
-* @param string $url the URL of the file to download
+*
-* @param int $timeout The timeout for the request to download the file default 300 seconds
+* @param string $url                    The URL of the file to download.
-* @return mixed WP_Error on failure, string Filename on success.
+* @param int    $timeout                The timeout for the request to download the file. Default 300 seconds.
-*/
+* @param bool   $signature_verification Whether to perform Signature Verification. Default false.
-function download_url( $url, $timeout = 300 ) {
+* @return string|WP_Error Filename on success, WP_Error on failure.
+*/
+function download_url( $url, $timeout = 300, $signature_verification = false ) {
 	//WARNING: The file is not automatically deleted, The script must unlink() the file.
-	if ( ! $url )
+	if ( ! $url ) {
-		return new WP_Error('http_no_url', __('Invalid URL Provided.'));
+		return new WP_Error( 'http_no_url', __( 'Invalid URL Provided.' ) );
+	}
 	$url_filename = basename( parse_url( $url, PHP_URL_PATH ) );
 	$tmpfname = wp_tempnam( $url_filename );
-	if ( ! $tmpfname )
+	if ( ! $tmpfname ) {
-		return new WP_Error('http_no_file', __('Could not create Temporary file.'));
+		return new WP_Error( 'http_no_file', __( 'Could not create Temporary file.' ) );
+	}
-	$response = wp_safe_remote_get( $url, array( 'timeout' => $timeout, 'stream' => true, 'filename' => $tmpfname ) );
+	$response = wp_safe_remote_get(
+		$url,
+		array(
+			'timeout'  => $timeout,
+			'stream'   => true,
+			'filename' => $tmpfname,
+		)
+	);
 	if ( is_wp_error( $response ) ) {
 		unlink( $tmpfname );
 		return $response;
 	}
-	if ( 200 != wp_remote_retrieve_response_code( $response ) ){
+	$response_code = wp_remote_retrieve_response_code( $response );
+	if ( 200 != $response_code ) {
+		$data = array(
+			'code' => $response_code,
+		);
+		// Retrieve a sample of the response body for debugging purposes.
+		$tmpf = fopen( $tmpfname, 'rb' );
+		if ( $tmpf ) {
+			/**
+			 * Filters the maximum error response body size in `download_url()`.
+			 *
+			 * @since 5.1.0
+			 *
+			 * @see download_url()
+			 *
+			 * @param int $size The maximum error response body size. Default 1 KB.
+			 */
+			$response_size = apply_filters( 'download_url_error_max_body_size', KB_IN_BYTES );
+			$data['body']  = fread( $tmpf, $response_size );
+			fclose( $tmpf );
+		}
 		unlink( $tmpfname );
-		return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ) );
+		return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data );
 	}
 	$content_md5 = wp_remote_retrieve_header( $response, 'content-md5' );
 	if ( $content_md5 ) {
 		$md5_check = verify_file_md5( $tmpfname, $content_md5 );
 			unlink( $tmpfname );
 			return $md5_check;
 		}
 	}
+	// If the caller expects signature verification to occur, check to see if this URL supports it.
+	if ( $signature_verification ) {
+		/**
+		 * Filters the list of hosts which should have Signature Verification attempteds on.
+		 *
+		 * @since 5.2.0
+		 *
+		 * @param array List of hostnames.
+		 */
+		$signed_hostnames       = apply_filters( 'wp_signature_hosts', array( 'wordpress.org', 'downloads.wordpress.org', 's.w.org' ) );
+		$signature_verification = in_array( parse_url( $url, PHP_URL_HOST ), $signed_hostnames, true );
+	}
+	// Perform signature valiation if supported.
+	if ( $signature_verification ) {
+		$signature = wp_remote_retrieve_header( $response, 'x-content-signature' );
+		if ( ! $signature ) {
+			// Retrieve signatures from a file if the header wasn't included.
+			// WordPress.org stores signatures at $package_url.sig
+			$signature_url = false;
+			$url_path      = parse_url( $url, PHP_URL_PATH );
+			if ( substr( $url_path, -4 ) == '.zip' || substr( $url_path, -7 ) == '.tar.gz' ) {
+				$signature_url = str_replace( $url_path, $url_path . '.sig', $url );
+			}
+			/**
+			 * Filter the URL where the signature for a file is located.
+			 *
+			 * @since 5.2.0
+			 *
+			 * @param false|string $signature_url The URL where signatures can be found for a file, or false if none are known.
+			 * @param string $url                 The URL being verified.
+			 */
+			$signature_url = apply_filters( 'wp_signature_url', $signature_url, $url );
+			if ( $signature_url ) {
+				$signature_request = wp_safe_remote_get(
+					$signature_url,
+					array(
+						'limit_response_size' => 10 * 1024, // 10KB should be large enough for quite a few signatures.
+					)
+				);
+				if ( ! is_wp_error( $signature_request ) && 200 === wp_remote_retrieve_response_code( $signature_request ) ) {
+					$signature = explode( "\n", wp_remote_retrieve_body( $signature_request ) );
+				}
+			}
+		}
+		// Perform the checks.
+		$signature_verification = verify_file_signature( $tmpfname, $signature, basename( parse_url( $url, PHP_URL_PATH ) ) );
+	}
+	if ( is_wp_error( $signature_verification ) ) {
+		if (
+			/**
+			 * Filters whether Signature Verification failures should be allowed to soft fail.
+			 *
+			 * WARNING: This may be removed from a future release.
+			 *
+			 * @since 5.2.0
+			 *
+			 * @param bool   $signature_softfail If a softfail is allowed.
+			 * @param string $url                The url being accessed.
+			 */
+			apply_filters( 'wp_signature_softfail', true, $url )
+		) {
+			$signature_verification->add_data( $tmpfname, 'softfail-filename' );
+		} else {
+			// Hard-fail.
+			unlink( $tmpfname );
+		}
+		return $signature_verification;
+	}
 	return $tmpfname;
 }
 /**
 * Calculates and compares the MD5 of a file to its expected value.
 *
 * @since 3.7.0
 *
-* @param string $filename The filename to check the MD5 of.
+* @param string $filename     The filename to check the MD5 of.
-* @param string $expected_md5 The expected MD5 of the file, either a base64 encoded raw md5, or a hex-encoded md5
+* @param string $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5,
-* @return bool|object WP_Error on failure, true on success, false when the MD5 format is unknown/unexpected
+*                             or a hex-encoded md5.
+* @return bool|WP_Error True on success, false when the MD5 format is unknown/unexpected,
+*                       WP_Error on failure.
 */
 function verify_file_md5( $filename, $expected_md5 ) {
-	if ( 32 == strlen( $expected_md5 ) )
+	if ( 32 == strlen( $expected_md5 ) ) {
 		$expected_raw_md5 = pack( 'H*', $expected_md5 );
-	elseif ( 24 == strlen( $expected_md5 ) )
+	} elseif ( 24 == strlen( $expected_md5 ) ) {
 		$expected_raw_md5 = base64_decode( $expected_md5 );
-	else
+	} else {
 		return false; // unknown format
+	}
 	$file_md5 = md5_file( $filename, true );
-	if ( $file_md5 === $expected_raw_md5 )
+	if ( $file_md5 === $expected_raw_md5 ) {
 		return true;
+	}
 	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 ) ) );
 }
 /**
-* Unzips a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction.
+* Verifies the contents of a file against its ED25519 signature.
-* Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present.
+*
-*
+* @since 5.2.0
-* Attempts to increase the PHP Memory limit to 256M before uncompressing,
+*
-* However, The most memory required shouldn't be much larger than the Archive itself.
+* @param string       $filename            The file to validate.
+* @param string|array $signatures          A Signature provided for the file.
+* @param string       $filename_for_errors A friendly filename for errors. Optional.
+*
+* @return bool|WP_Error true on success, false if verificaiton not attempted, or WP_Error describing an error condition.
+*/
+function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {
+	if ( ! $filename_for_errors ) {
+		$filename_for_errors = wp_basename( $filename );
+	}
+	// Check we can process signatures.
+	if ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) || ! in_array( 'sha384', array_map( 'strtolower', hash_algos() ) ) ) {
+		return new WP_Error(
+			'signature_verification_unsupported',
+			sprintf(
+				/* translators: %s: The filename of the package. */
+				__( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ),
+				'<span class="code">' . esc_html( $filename_for_errors ) . '</span>'
+			),
+			( ! function_exists( 'sodium_crypto_sign_verify_detached' ) ? 'sodium_crypto_sign_verify_detached' : 'sha384' )
+		);
+	}
+	// Check for a edge-case affecting PHP Maths abilities
+	if (
+		! extension_loaded( 'sodium' ) &&
+		in_array( PHP_VERSION_ID, [ 70200, 70201, 70202 ], true ) &&
+		extension_loaded( 'opcache' )
+	) {
+		// Sodium_Compat isn't compatible with PHP 7.2.0~7.2.2 due to a bug in the PHP Opcache extension, bail early as it'll fail.
+		// https://bugs.php.net/bug.php?id=75938
+		return new WP_Error(
+			'signature_verification_unsupported',
+			sprintf(
+				/* translators: %s: The filename of the package. */
+				__( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ),
+				'<span class="code">' . esc_html( $filename_for_errors ) . '</span>'
+			),
+			array(
+				'php'    => phpversion(),
+				'sodium' => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ),
+			)
+		);
+	}
+	// Verify runtime speed of Sodium_Compat is acceptable.
+	if ( ! extension_loaded( 'sodium' ) && ! ParagonIE_Sodium_Compat::polyfill_is_fast() ) {
+		$sodium_compat_is_fast = false;
+		// Allow for an old version of Sodium_Compat being loaded before the bundled WordPress one.
+		if ( method_exists( 'ParagonIE_Sodium_Compat', 'runtime_speed_test' ) ) {
+			// Run `ParagonIE_Sodium_Compat::runtime_speed_test()` in optimized integer mode, as that's what WordPress utilises during signing verifications.
+			$old_fastMult                      = ParagonIE_Sodium_Compat::$fastMult;
+			ParagonIE_Sodium_Compat::$fastMult = true;
+			$sodium_compat_is_fast             = ParagonIE_Sodium_Compat::runtime_speed_test( 100, 10 );
+			ParagonIE_Sodium_Compat::$fastMult = $old_fastMult;
+		}
+		// This cannot be performed in a reasonable amount of time
+		// https://github.com/paragonie/sodium_compat#help-sodium_compat-is-slow-how-can-i-make-it-fast
+		if ( ! $sodium_compat_is_fast ) {
+			return new WP_Error(
+				'signature_verification_unsupported',
+				sprintf(
+					/* translators: %s: The filename of the package. */
+					__( 'The authenticity of %s could not be verified as signature verification is unavailable on this system.' ),
+					'<span class="code">' . esc_html( $filename_for_errors ) . '</span>'
+				),
+				array(
+					'php'                => phpversion(),
+					'sodium'             => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ),
+					'polyfill_is_fast'   => false,
+					'max_execution_time' => ini_get( 'max_execution_time' ),
+				)
+			);
+		}
+	}
+	if ( ! $signatures ) {
+		return new WP_Error(
+			'signature_verification_no_signature',
+			sprintf(
+				/* translators: %s: The filename of the package. */
+				__( 'The authenticity of %s could not be verified as no signature was found.' ),
+				'<span class="code">' . esc_html( $filename_for_errors ) . '</span>'
+			),
+			array(
+				'filename' => $filename_for_errors,
+			)
+		);
+	}
+	$trusted_keys = wp_trusted_keys();
+	$file_hash    = hash_file( 'sha384', $filename, true );
+	mbstring_binary_safe_encoding();
+	$skipped_key = $skipped_signature = 0;
+	foreach ( (array) $signatures as $signature ) {
+		$signature_raw = base64_decode( $signature );
+		// Ensure only valid-length signatures are considered.
+		if ( SODIUM_CRYPTO_SIGN_BYTES !== strlen( $signature_raw ) ) {
+			$skipped_signature++;
+			continue;
+		}
+		foreach ( (array) $trusted_keys as $key ) {
+			$key_raw = base64_decode( $key );
+			// Only pass valid public keys through.
+			if ( SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES !== strlen( $key_raw ) ) {
+				$skipped_key++;
+				continue;
+			}
+			if ( sodium_crypto_sign_verify_detached( $signature_raw, $file_hash, $key_raw ) ) {
+				reset_mbstring_encoding();
+				return true;
+			}
+		}
+	}
+	reset_mbstring_encoding();
+	return new WP_Error(
+		'signature_verification_failed',
+		sprintf(
+			/* translators: %s: The filename of the package. */
+			__( 'The authenticity of %s could not be verified.' ),
+			'<span class="code">' . esc_html( $filename_for_errors ) . '</span>'
+		),
+		// Error data helpful for debugging:
+		array(
+			'filename'    => $filename_for_errors,
+			'keys'        => $trusted_keys,
+			'signatures'  => $signatures,
+			'hash'        => bin2hex( $file_hash ),
+			'skipped_key' => $skipped_key,
+			'skipped_sig' => $skipped_signature,
+			'php'         => phpversion(),
+			'sodium'      => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ),
+		)
+	);
+}
+/**
+* Retrieve the list of signing keys trusted by WordPress.
+*
+* @since 5.2.0
+*
+* @return array List of base64-encoded Signing keys.
+*/
+function wp_trusted_keys() {
+	$trusted_keys = array();
+	if ( time() < 1617235200 ) {
+		// WordPress.org Key #1 - This key is only valid before April 1st, 2021.
+		$trusted_keys[] = 'fRPyrxb/MvVLbdsYi+OOEv4xc+Eqpsj+kkAS6gNOkI0=';
+	}
+	// TODO: Add key #2 with longer expiration.
+	/**
+	 * Filter the valid Signing keys used to verify the contents of files.
+	 *
+	 * @since 5.2.0
+	 *
+	 * @param array $trusted_keys The trusted keys that may sign packages.
+	 */
+	return apply_filters( 'wp_trusted_keys', $trusted_keys );
+}
+/**
+* Unzips a specified ZIP file to a location on the filesystem via the WordPress
+* Filesystem Abstraction.
+*
+* 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 larger than the archive itself.
 *
 * @since 2.5.0
 *
-* @global WP_Filesystem_Base $wp_filesystem Subclass
+* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
 *
-* @param string $file Full path and filename of zip archive
+* @param string $file Full path and filename of ZIP archive.
-* @param string $to Full path on the filesystem to extract archive to
+* @param string $to   Full path on the filesystem to extract archive to.
-* @return mixed WP_Error on failure, True on success
+* @return true|WP_Error True on success, WP_Error on failure.
 */
-function unzip_file($file, $to) {
+function unzip_file( $file, $to ) {
 	global $wp_filesystem;
-	if ( ! $wp_filesystem || !is_object($wp_filesystem) )
+	if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) {
-		return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
+		return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
+	}
 	// Unzip can use a lot of memory, but not this much hopefully.
 	wp_raise_memory_limit( 'admin' );
 	$needed_dirs = array();
-	$to = trailingslashit($to);
+	$to          = trailingslashit( $to );
-	// Determine any parent dir's needed (of the upgrade directory)
+	// Determine any parent directories needed (of the upgrade directory).
-	if ( ! $wp_filesystem->is_dir($to) ) { //Only do parents if no children exist
+	if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parents if no children exist.
-		$path = preg_split('![/\\\]!', untrailingslashit($to));
+		$path = preg_split( '![/\\\]!', untrailingslashit( $to ) );
-		for ( $i = count($path); $i >= 0; $i-- ) {
+		for ( $i = count( $path ); $i >= 0; $i-- ) {
-			if ( empty($path[$i]) )
+			if ( empty( $path[ $i ] ) ) {
 				continue;
+			}
-			$dir = implode('/', array_slice($path, 0, $i+1) );
-			if ( preg_match('!^[a-z]:$!i', $dir) ) // Skip it if it looks like a Windows Drive letter.
+			$dir = implode( '/', array_slice( $path, 0, $i + 1 ) );
+			if ( preg_match( '!^[a-z]:$!i', $dir ) ) { // Skip it if it looks like a Windows Drive letter.
 				continue;
+			}
-			if ( ! $wp_filesystem->is_dir($dir) )
+			if ( ! $wp_filesystem->is_dir( $dir ) ) {
 				$needed_dirs[] = $dir;
-			else
+			} else {
-				break; // A folder exists, therefor, we dont need the check the levels below this
+				break; // A folder exists, therefore we don't need to check the levels below this.
+			}
 		}
 	}
 	/**
 	 * Filters whether to use ZipArchive to unzip archives.
 	 * @since 3.0.0
 	 *
 	 * @param bool $ziparchive Whether to use ZipArchive. Default true.
 	 */
 	if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
-		$result = _unzip_file_ziparchive($file, $to, $needed_dirs);
+		$result = _unzip_file_ziparchive( $file, $to, $needed_dirs );
 		if ( true === $result ) {
 			return $result;
-		} elseif ( is_wp_error($result) ) {
+		} elseif ( is_wp_error( $result ) ) {
-			if ( 'incompatible_archive' != $result->get_error_code() )
+			if ( 'incompatible_archive' != $result->get_error_code() ) {
 				return $result;
+			}
 		}
 	}
 	// Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
-	return _unzip_file_pclzip($file, $to, $needed_dirs);
+	return _unzip_file_pclzip( $file, $to, $needed_dirs );
 }
 /**
-* This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the ZipArchive class.
+* Attempts to unzip an archive using the ZipArchive class.
+*
+* This function should not be called directly, use `unzip_file()` instead.
+*
 * Assumes that WP_Filesystem() has already been called and set up.
 *
 * @since 3.0.0
-* @see unzip_file
+* @see unzip_file()
 * @access private
 *
-* @global WP_Filesystem_Base $wp_filesystem Subclass
+* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
 *
-* @param string $file Full path and filename of zip archive
+* @param string $file       Full path and filename of ZIP archive.
-* @param string $to Full path on the filesystem to extract archive to
+* @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
+* @return true|WP_Error True on success, WP_Error on failure.
 */
-function _unzip_file_ziparchive($file, $to, $needed_dirs = array() ) {
+function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) {
 	global $wp_filesystem;
 	$z = new ZipArchive();
 	$zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS );
-	if ( true !== $zopen )
+	if ( true !== $zopen ) {
 		return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) );
+	}
 	$uncompressed_size = 0;
 	for ( $i = 0; $i < $z->numFiles; $i++ ) {
-		if ( ! $info = $z->statIndex($i) )
+		if ( ! $info = $z->statIndex( $i ) ) {
 			return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
+		}
-		if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Skip the OS X-created __MACOSX directory
+		if ( '__MACOSX/' === substr( $info['name'], 0, 9 ) ) { // Skip the OS X-created __MACOSX directory
 			continue;
+		}
 		// Don't extract invalid files:
 		if ( 0 !== validate_file( $info['name'] ) ) {
 			continue;
 		}
 	 * A disk that has zero free bytes has bigger problems.
 	 * Require we have enough space to unzip the file and copy its contents, with a 10% buffer.
 	 */
 	if ( wp_doing_cron() ) {
 		$available_space = @disk_free_space( WP_CONTENT_DIR );
-		if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space )
+		if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) {
 			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' ) );
-	}
+		}
+	}
-	$needed_dirs = array_unique($needed_dirs);
+	$needed_dirs = array_unique( $needed_dirs );
 	foreach ( $needed_dirs as $dir ) {
 		// Check the parent folders of the folders all exist within the creation array.
-		if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist)
+		if ( untrailingslashit( $to ) == $dir ) { // Skip over the working directory, We know this exists (or will exist)
 			continue;
-		if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it
+		}
+		if ( strpos( $dir, $to ) === false ) { // If the directory is not within the working directory, Skip it
 			continue;
+		}
-		$parent_folder = dirname($dir);
-		while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) {
+		$parent_folder = dirname( $dir );
+		while ( ! empty( $parent_folder ) && untrailingslashit( $to ) != $parent_folder && ! in_array( $parent_folder, $needed_dirs ) ) {
 			$needed_dirs[] = $parent_folder;
-			$parent_folder = dirname($parent_folder);
+			$parent_folder = dirname( $parent_folder );
 		}
 	}
-	asort($needed_dirs);
+	asort( $needed_dirs );
 	// Create those directories if need be:
 	foreach ( $needed_dirs as $_dir ) {
 		// Only check to see if the Dir exists upon creation failure. Less I/O this way.
 		if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) ) {
 			return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) );
 		}
 	}
-	unset($needed_dirs);
+	unset( $needed_dirs );
 	for ( $i = 0; $i < $z->numFiles; $i++ ) {
-		if ( ! $info = $z->statIndex($i) )
+		if ( ! $info = $z->statIndex( $i ) ) {
 			return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
+		}
-		if ( '/' == substr($info['name'], -1) ) // directory
+		if ( '/' == substr( $info['name'], -1 ) ) { // directory
 			continue;
+		}
-		if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files
+		if ( '__MACOSX/' === substr( $info['name'], 0, 9 ) ) { // Don't extract the OS X-created __MACOSX directory files
 			continue;
+		}
 		// Don't extract invalid files:
 		if ( 0 !== validate_file( $info['name'] ) ) {
 			continue;
 		}
-		$contents = $z->getFromIndex($i);
+		$contents = $z->getFromIndex( $i );
-		if ( false === $contents )
+		if ( false === $contents ) {
 			return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] );
+		}
-		if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE) )
+		if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE ) ) {
 			return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] );
+		}
 	}
 	$z->close();
 	return true;
 }
 /**
-* This function should not be called directly, use unzip_file instead. Attempts to unzip an archive using the PclZip library.
+* Attempts to unzip an archive using the PclZip library.
+*
+* This function should not be called directly, use `unzip_file()` instead.
+*
 * Assumes that WP_Filesystem() has already been called and set up.
 *
 * @since 3.0.0
-* @see unzip_file
+* @see unzip_file()
 * @access private
 *
-* @global WP_Filesystem_Base $wp_filesystem Subclass
+* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
 *
-* @param string $file Full path and filename of zip archive
+* @param string $file       Full path and filename of ZIP archive.
-* @param string $to Full path on the filesystem to extract archive to
+* @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
+* @return true|WP_Error True on success, WP_Error on failure.
 */
-function _unzip_file_pclzip($file, $to, $needed_dirs = array()) {
+function _unzip_file_pclzip( $file, $to, $needed_dirs = array() ) {
 	global $wp_filesystem;
 	mbstring_binary_safe_encoding();
-	require_once(ABSPATH . 'wp-admin/includes/class-pclzip.php');
+	require_once( ABSPATH . 'wp-admin/includes/class-pclzip.php' );
-	$archive = new PclZip($file);
+	$archive = new PclZip( $file );
-	$archive_files = $archive->extract(PCLZIP_OPT_EXTRACT_AS_STRING);
+	$archive_files = $archive->extract( PCLZIP_OPT_EXTRACT_AS_STRING );
 	reset_mbstring_encoding();
 	// Is the archive valid?
-	if ( !is_array($archive_files) )
+	if ( ! is_array( $archive_files ) ) {
-		return new WP_Error('incompatible_archive', __('Incompatible Archive.'), $archive->errorInfo(true));
+		return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), $archive->errorInfo( true ) );
+	}
-	if ( 0 == count($archive_files) )
+	if ( 0 == count( $archive_files ) ) {
 		return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) );
+	}
 	$uncompressed_size = 0;
 	// Determine any children directories needed (From within the archive)
 	foreach ( $archive_files as $file ) {
-		if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Skip the OS X-created __MACOSX directory
+		if ( '__MACOSX/' === substr( $file['filename'], 0, 9 ) ) { // Skip the OS X-created __MACOSX directory
 			continue;
+		}
 		$uncompressed_size += $file['size'];
-		$needed_dirs[] = $to . untrailingslashit( $file['folder'] ? $file['filename'] : dirname($file['filename']) );
+		$needed_dirs[] = $to . untrailingslashit( $file['folder'] ? $file['filename'] : dirname( $file['filename'] ) );
 	}
 	/*
 	 * disk_free_space() could return false. Assume that any falsey value is an error.
 	 * A disk that has zero free bytes has bigger problems.
 	 * Require we have enough space to unzip the file and copy its contents, with a 10% buffer.
 	 */
 	if ( wp_doing_cron() ) {
 		$available_space = @disk_free_space( WP_CONTENT_DIR );
-		if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space )
+		if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) {
 			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' ) );
-	}
+		}
+	}
-	$needed_dirs = array_unique($needed_dirs);
+	$needed_dirs = array_unique( $needed_dirs );
 	foreach ( $needed_dirs as $dir ) {
 		// Check the parent folders of the folders all exist within the creation array.
-		if ( untrailingslashit($to) == $dir ) // Skip over the working directory, We know this exists (or will exist)
+		if ( untrailingslashit( $to ) == $dir ) { // Skip over the working directory, We know this exists (or will exist)
 			continue;
-		if ( strpos($dir, $to) === false ) // If the directory is not within the working directory, Skip it
+		}
+		if ( strpos( $dir, $to ) === false ) { // If the directory is not within the working directory, Skip it
 			continue;
+		}
-		$parent_folder = dirname($dir);
-		while ( !empty($parent_folder) && untrailingslashit($to) != $parent_folder && !in_array($parent_folder, $needed_dirs) ) {
+		$parent_folder = dirname( $dir );
+		while ( ! empty( $parent_folder ) && untrailingslashit( $to ) != $parent_folder && ! in_array( $parent_folder, $needed_dirs ) ) {
 			$needed_dirs[] = $parent_folder;
-			$parent_folder = dirname($parent_folder);
+			$parent_folder = dirname( $parent_folder );
 		}
 	}
-	asort($needed_dirs);
+	asort( $needed_dirs );
 	// Create those directories if need be:
 	foreach ( $needed_dirs as $_dir ) {
 		// Only check to see if the dir exists upon creation failure. Less I/O this way.
-		if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) )
+		if ( ! $wp_filesystem->mkdir( $_dir, FS_CHMOD_DIR ) && ! $wp_filesystem->is_dir( $_dir ) ) {
 			return new WP_Error( 'mkdir_failed_pclzip', __( 'Could not create directory.' ), substr( $_dir, strlen( $to ) ) );
-	}
+		}
-	unset($needed_dirs);
+	}
+	unset( $needed_dirs );
 	// Extract the files from the zip
 	foreach ( $archive_files as $file ) {
-		if ( $file['folder'] )
+		if ( $file['folder'] ) {
 			continue;
+		}
-		if ( '__MACOSX/' === substr($file['filename'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files
+		if ( '__MACOSX/' === substr( $file['filename'], 0, 9 ) ) { // Don't extract the OS X-created __MACOSX directory files
 			continue;
+		}
 		// Don't extract invalid files:
 		if ( 0 !== validate_file( $file['filename'] ) ) {
 			continue;
 		}
-		if ( ! $wp_filesystem->put_contents( $to . $file['filename'], $file['content'], FS_CHMOD_FILE) )
+		if ( ! $wp_filesystem->put_contents( $to . $file['filename'], $file['content'], FS_CHMOD_FILE ) ) {
 			return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $file['filename'] );
+		}
 	}
 	return true;
 }
 /**
-* Copies a directory from one location to another via the WordPress Filesystem Abstraction.
+* Copies a directory from one location to another via the WordPress Filesystem
+* Abstraction.
+*
 * Assumes that WP_Filesystem() has already been called and setup.
 *
 * @since 2.5.0
 *
-* @global WP_Filesystem_Base $wp_filesystem Subclass
+* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
 *
-* @param string $from source directory
+* @param string $from     Source directory.
-* @param string $to destination directory
+* @param string $to       Destination directory.
-* @param array $skip_list a list of files/folders to skip copying
+* @param array $skip_list A list of files/folders to skip copying.
-* @return mixed WP_Error on failure, True on success.
+* @return true|WP_Error True on success, WP_Error on failure.
 */
-function copy_dir($from, $to, $skip_list = array() ) {
+function copy_dir( $from, $to, $skip_list = array() ) {
 	global $wp_filesystem;
-	$dirlist = $wp_filesystem->dirlist($from);
+	$dirlist = $wp_filesystem->dirlist( $from );
-	$from = trailingslashit($from);
+	$from = trailingslashit( $from );
-	$to = trailingslashit($to);
+	$to   = trailingslashit( $to );
 	foreach ( (array) $dirlist as $filename => $fileinfo ) {
-		if ( in_array( $filename, $skip_list ) )
+		if ( in_array( $filename, $skip_list ) ) {
 			continue;
+		}
 		if ( 'f' == $fileinfo['type'] ) {
-			if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) ) {
+			if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) {
 				// If copy failed, chmod file to 0644 and try again.
 				$wp_filesystem->chmod( $to . $filename, FS_CHMOD_FILE );
-				if ( ! $wp_filesystem->copy($from . $filename, $to . $filename, true, FS_CHMOD_FILE) )
+				if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) {
 					return new WP_Error( 'copy_failed_copy_dir', __( 'Could not copy file.' ), $to . $filename );
+				}
 			}
 		} elseif ( 'd' == $fileinfo['type'] ) {
-			if ( !$wp_filesystem->is_dir($to . $filename) ) {
+			if ( ! $wp_filesystem->is_dir( $to . $filename ) ) {
-				if ( !$wp_filesystem->mkdir($to . $filename, FS_CHMOD_DIR) )
+				if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) {
 					return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename );
+				}
 			}
 			// generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list
 			$sub_skip_list = array();
 			foreach ( $skip_list as $skip_item ) {
-				if ( 0 === strpos( $skip_item, $filename . '/' ) )
+				if ( 0 === strpos( $skip_item, $filename . '/' ) ) {
 					$sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
+				}
 			}
-			$result = copy_dir($from . $filename, $to . $filename, $sub_skip_list);
+			$result = copy_dir( $from . $filename, $to . $filename, $sub_skip_list );
-			if ( is_wp_error($result) )
+			if ( is_wp_error( $result ) ) {
 				return $result;
+			}
 		}
 	}
 	return true;
 }
 /**
 * Initialises and connects the WordPress Filesystem Abstraction classes.
+*
 * This function will include the chosen transport and attempt connecting.
 *
 * Plugins may add extra transports, And force WordPress to use them by returning
 * the filename via the {@see 'filesystem_method_file'} filter.
 *
 * @since 2.5.0
 *
-* @global WP_Filesystem_Base $wp_filesystem Subclass
+* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
 *
 * @param array|false  $args                         Optional. Connection args, These are passed directly to
 *                                                   the `WP_Filesystem_*()` classes. Default false.
 * @param string|false $context                      Optional. Context for get_filesystem_method(). Default false.
 * @param bool         $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
-* @return null|bool false on failure, true on success.
+* @return bool|null True on success, false on failure, null if the filesystem method class file does not exist.
 */
 function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) {
 	global $wp_filesystem;
-	require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+	require_once( ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php' );
 	$method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership );
-	if ( ! $method )
+	if ( ! $method ) {
 		return false;
+	}
 	if ( ! class_exists( "WP_Filesystem_$method" ) ) {
 		/**
 		 * Filters the path for a specific filesystem method class file.
 		 * @param string $path   Path to the specific filesystem method class file.
 		 * @param string $method The filesystem method to use.
 		 */
 		$abstraction_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );
-		if ( ! file_exists($abstraction_file) )
+		if ( ! file_exists( $abstraction_file ) ) {
 			return;
+		}
-		require_once($abstraction_file);
+		require_once( $abstraction_file );
 	}
 	$method = "WP_Filesystem_$method";
-	$wp_filesystem = new $method($args);
+	$wp_filesystem = new $method( $args );
 	//Define the timeouts for the connections. Only available after the construct is called to allow for per-transport overriding of the default.
-	if ( ! defined('FS_CONNECT_TIMEOUT') )
+	if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {
-		define('FS_CONNECT_TIMEOUT', 30);
+		define( 'FS_CONNECT_TIMEOUT', 30 );
-	if ( ! defined('FS_TIMEOUT') )
+	}
-		define('FS_TIMEOUT', 30);
+	if ( ! defined( 'FS_TIMEOUT' ) ) {
+		define( 'FS_TIMEOUT', 30 );
-	if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
+	}
+	if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
 		return false;
+	}
-	if ( !$wp_filesystem->connect() )
+	if ( ! $wp_filesystem->connect() ) {
 		return false; //There was an error connecting to the server.
+	}
 	// Set the permission constants if not already set.
-	if ( ! defined('FS_CHMOD_DIR') )
+	if ( ! defined( 'FS_CHMOD_DIR' ) ) {
-		define('FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
+		define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
-	if ( ! defined('FS_CHMOD_FILE') )
+	}
-		define('FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
+	if ( ! defined( 'FS_CHMOD_FILE' ) ) {
+		define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
+	}
 	return true;
 }
 /**
 * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
 *                                             Default false.
 * @return string The transport to use, see description for valid return values.
 */
 function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) {
-	$method = defined('FS_METHOD') ? FS_METHOD : false; // Please ensure that this is either 'direct', 'ssh2', 'ftpext' or 'ftpsockets'
+	$method = defined( 'FS_METHOD' ) ? FS_METHOD : false; // Please ensure that this is either 'direct', 'ssh2', 'ftpext' or 'ftpsockets'
 	if ( ! $context ) {
 		$context = WP_CONTENT_DIR;
 	}
 	$context = trailingslashit( $context );
 	if ( ! $method ) {
-		$temp_file_name = $context . 'temp-write-test-' . time();
+		$temp_file_name = $context . 'temp-write-test-' . str_replace( '.', '-', uniqid( '', true ) );
-		$temp_handle = @fopen($temp_file_name, 'w');
+		$temp_handle    = @fopen( $temp_file_name, 'w' );
 		if ( $temp_handle ) {
 			// Attempt to determine the file owner of the WordPress files, and that of newly created files
 			$wp_file_owner = $temp_file_owner = false;
-			if ( function_exists('fileowner') ) {
+			if ( function_exists( 'fileowner' ) ) {
-				$wp_file_owner = @fileowner( __FILE__ );
+				$wp_file_owner   = @fileowner( __FILE__ );
 				$temp_file_owner = @fileowner( $temp_file_name );
 			}
 			if ( $wp_file_owner !== false && $wp_file_owner === $temp_file_owner ) {
 				// WordPress is creating files as the same owner as the WordPress files,
 				// this means it's safe to modify & create new files via PHP.
-				$method = 'direct';
+				$method                                  = 'direct';
 				$GLOBALS['_wp_filesystem_direct_method'] = 'file_owner';
 			} elseif ( $allow_relaxed_file_ownership ) {
 				// The $context directory is writable, and $allow_relaxed_file_ownership is set, this means we can modify files
 				// safely in this directory. This mode doesn't create new files, only alter existing ones.
-				$method = 'direct';
+				$method                                  = 'direct';
 				$GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
 			}
-			@fclose($temp_handle);
+			@fclose( $temp_handle );
-			@unlink($temp_file_name);
+			@unlink( $temp_file_name );
 		}
 	}
-	if ( ! $method && isset($args['connection_type']) && 'ssh' == $args['connection_type'] && extension_loaded('ssh2') && function_exists('stream_get_contents') ) $method = 'ssh2';
+	if ( ! $method && isset( $args['connection_type'] ) && 'ssh' == $args['connection_type'] && extension_loaded( 'ssh2' ) && function_exists( 'stream_get_contents' ) ) {
-	if ( ! $method && extension_loaded('ftp') ) $method = 'ftpext';
+		$method = 'ssh2';
-	if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread
+	}
+	if ( ! $method && extension_loaded( 'ftp' ) ) {
+		$method = 'ftpext';
+	}
+	if ( ! $method && ( extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) ) {
+		$method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread
+	}
 	/**
 	 * Filters the filesystem method to use.
 	 *
 	 * @since 2.6.0
 *                                             writable. Default empty.
 * @param array  $extra_fields                 Optional. Extra `POST` fields to be checked for inclusion in
 *                                             the post. Default null.
 * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
 *
-* @return bool False on failure, true on success.
+* @return bool True on success, false on failure.
 */
 function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
 	global $pagenow;
 	/**
 	 * @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
 	 *                                             Default false.
 	 * @param array  $extra_fields                 Extra POST fields.
 	 */
 	$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
-	if ( '' !== $req_cred )
+	if ( '' !== $req_cred ) {
 		return $req_cred;
+	}
-	if ( empty($type) ) {
+	if ( empty( $type ) ) {
 		$type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
 	}
-	if ( 'direct' == $type )
+	if ( 'direct' == $type ) {
 		return true;
+	}
-	if ( is_null( $extra_fields ) )
+	if ( is_null( $extra_fields ) ) {
 		$extra_fields = array( 'version', 'locale' );
+	}
-	$credentials = get_option('ftp_credentials', array( 'hostname' => '', 'username' => ''));
+	$credentials = get_option(
+		'ftp_credentials',
+		array(
+			'hostname' => '',
+			'username' => '',
+		)
+	);
 	$submitted_form = wp_unslash( $_POST );
 	// Verify nonce, or unset submitted form field values on failure
 	if ( ! isset( $_POST['_fs_nonce'] ) || ! wp_verify_nonce( $_POST['_fs_nonce'], 'filesystem-credentials' ) ) {
 			$submitted_form['connection_type']
 		);
 	}
 	// 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)
-	$credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : (!empty($submitted_form['hostname']) ? $submitted_form['hostname'] : $credentials['hostname']);
+	$credentials['hostname'] = defined( 'FTP_HOST' ) ? FTP_HOST : ( ! empty( $submitted_form['hostname'] ) ? $submitted_form['hostname'] : $credentials['hostname'] );
-	$credentials['username'] = defined('FTP_USER') ? FTP_USER : (!empty($submitted_form['username']) ? $submitted_form['username'] : $credentials['username']);
+	$credentials['username'] = defined( 'FTP_USER' ) ? FTP_USER : ( ! empty( $submitted_form['username'] ) ? $submitted_form['username'] : $credentials['username'] );
-	$credentials['password'] = defined('FTP_PASS') ? FTP_PASS : (!empty($submitted_form['password']) ? $submitted_form['password'] : '');
+	$credentials['password'] = defined( 'FTP_PASS' ) ? FTP_PASS : ( ! empty( $submitted_form['password'] ) ? $submitted_form['password'] : '' );
 	// Check to see if we are setting the public/private keys for ssh
-	$credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : (!empty($submitted_form['public_key']) ? $submitted_form['public_key'] : '');
+	$credentials['public_key']  = defined( 'FTP_PUBKEY' ) ? FTP_PUBKEY : ( ! empty( $submitted_form['public_key'] ) ? $submitted_form['public_key'] : '' );
-	$credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : (!empty($submitted_form['private_key']) ? $submitted_form['private_key'] : '');
+	$credentials['private_key'] = defined( 'FTP_PRIKEY' ) ? FTP_PRIKEY : ( ! empty( $submitted_form['private_key'] ) ? $submitted_form['private_key'] : '' );
 	// Sanitize the hostname, Some people might pass in odd-data:
-	$credentials['hostname'] = preg_replace('|\w+://|', '', $credentials['hostname']); //Strip any schemes off
+	$credentials['hostname'] = preg_replace( '|\w+://|', '', $credentials['hostname'] ); //Strip any schemes off
-	if ( strpos($credentials['hostname'], ':') ) {
+	if ( strpos( $credentials['hostname'], ':' ) ) {
-		list( $credentials['hostname'], $credentials['port'] ) = explode(':', $credentials['hostname'], 2);
+		list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 );
-		if ( ! is_numeric($credentials['port']) )
+		if ( ! is_numeric( $credentials['port'] ) ) {
-			unset($credentials['port']);
+			unset( $credentials['port'] );
+		}
 	} else {
-		unset($credentials['port']);
+		unset( $credentials['port'] );
 	}
 	if ( ( defined( 'FTP_SSH' ) && FTP_SSH ) || ( defined( 'FS_METHOD' ) && 'ssh2' == FS_METHOD ) ) {
 		$credentials['connection_type'] = 'ssh';
 	} elseif ( ( defined( 'FTP_SSL' ) && FTP_SSL ) && 'ftpext' == $type ) { //Only the FTP Extension understands SSL
 	} elseif ( ! isset( $credentials['connection_type'] ) ) { //All else fails (And it's not defaulted to something else saved), Default to FTP
 		$credentials['connection_type'] = 'ftp';
 	}
 	if ( ! $error &&
 			(
-				( !empty($credentials['password']) && !empty($credentials['username']) && !empty($credentials['hostname']) ) ||
+				( ! empty( $credentials['password'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['hostname'] ) ) ||
-				( 'ssh' == $credentials['connection_type'] && !empty($credentials['public_key']) && !empty($credentials['private_key']) )
+				( 'ssh' == $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] ) )
 			) ) {
 		$stored_credentials = $credentials;
-		if ( !empty($stored_credentials['port']) ) //save port as part of hostname to simplify above code.
+		if ( ! empty( $stored_credentials['port'] ) ) { //save port as part of hostname to simplify above code.
 			$stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
+		}
-		unset($stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key']);
+		unset( $stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key'] );
 		if ( ! wp_installing() ) {
 			update_option( 'ftp_credentials', $stored_credentials );
 		}
 		return $credentials;
 	}
-	$hostname = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
+	$hostname        = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
-	$username = isset( $credentials['username'] ) ? $credentials['username'] : '';
+	$username        = isset( $credentials['username'] ) ? $credentials['username'] : '';
-	$public_key = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
+	$public_key      = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
-	$private_key = isset( $credentials['private_key'] ) ? $credentials['private_key'] : '';
+	$private_key     = isset( $credentials['private_key'] ) ? $credentials['private_key'] : '';
-	$port = isset( $credentials['port'] ) ? $credentials['port'] : '';
+	$port            = isset( $credentials['port'] ) ? $credentials['port'] : '';
 	$connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : '';
 	if ( $error ) {
-		$error_string = __('<strong>ERROR:</strong> There was an error connecting to the server, Please verify the settings are correct.');
+		$error_string = __( '<strong>ERROR:</strong> There was an error connecting to the server, Please verify the settings are correct.' );
-		if ( is_wp_error($error) )
+		if ( is_wp_error( $error ) ) {
 			$error_string = esc_html( $error->get_error_message() );
+		}
 		echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';
 	}
 	$types = array();
-	if ( extension_loaded('ftp') || extension_loaded('sockets') || function_exists('fsockopen') )
+	if ( extension_loaded( 'ftp' ) || extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) {
-		$types[ 'ftp' ] = __('FTP');
+		$types['ftp'] = __( 'FTP' );
-	if ( extension_loaded('ftp') ) //Only this supports FTPS
+	}
-		$types[ 'ftps' ] = __('FTPS (SSL)');
+	if ( extension_loaded( 'ftp' ) ) { //Only this supports FTPS
-	if ( extension_loaded('ssh2') && function_exists('stream_get_contents') )
+		$types['ftps'] = __( 'FTPS (SSL)' );
-		$types[ 'ssh' ] = __('SSH2');
+	}
+	if ( extension_loaded( 'ssh2' ) && function_exists( 'stream_get_contents' ) ) {
+		$types['ssh'] = __( 'SSH2' );
+	}
 	/**
 	 * Filters the connection types to output to the filesystem credentials form.
 	 *
 	 * @since 2.9.0
 	 * @param string $context     Full path to the directory that is tested
 	 *                            for being writable.
 	 */
 	$types = apply_filters( 'fs_ftp_connection_types', $types, $credentials, $type, $error, $context );
-?>
+	?>
-<form action="<?php echo esc_url( $form_post ) ?>" method="post">
+<form action="<?php echo esc_url( $form_post ); ?>" method="post">
 <div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form">
-<?php
+	<?php
-// Print a H1 heading in the FTP credentials modal dialog, default is a H2.
+	// Print a H1 heading in the FTP credentials modal dialog, default is a H2.
-$heading_tag = 'h2';
+	$heading_tag = 'h2';
-if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) {
+	if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) {
-	$heading_tag = 'h1';
+		$heading_tag = 'h1';
-}
+	}
-echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>";
+	echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>";
-?>
+	?>
-<p id="request-filesystem-credentials-desc"><?php
+<p id="request-filesystem-credentials-desc">
-	$label_user = __('Username');
+	<?php
-	$label_pass = __('Password');
+	$label_user = __( 'Username' );
-	_e('To perform the requested action, WordPress needs to access your web server.');
+	$label_pass = __( 'Password' );
+	_e( 'To perform the requested action, WordPress needs to access your web server.' );
 	echo ' ';
 	if ( ( isset( $types['ftp'] ) || isset( $types['ftps'] ) ) ) {
 		if ( isset( $types['ssh'] ) ) {
-			_e('Please enter your FTP or SSH credentials to proceed.');
+			_e( 'Please enter your FTP or SSH credentials to proceed.' );
-			$label_user = __('FTP/SSH Username');
+			$label_user = __( 'FTP/SSH Username' );
-			$label_pass = __('FTP/SSH Password');
+			$label_pass = __( 'FTP/SSH Password' );
 		} else {
-			_e('Please enter your FTP credentials to proceed.');
+			_e( 'Please enter your FTP credentials to proceed.' );
-			$label_user = __('FTP Username');
+			$label_user = __( 'FTP Username' );
-			$label_pass = __('FTP Password');
+			$label_pass = __( 'FTP Password' );
 		}
 		echo ' ';
 	}
-	_e('If you do not remember your credentials, you should contact your web host.');
+	_e( 'If you do not remember your credentials, you should contact your web host.' );
-?></p>
+	$hostname_value = esc_attr( $hostname );
+	if ( ! empty( $port ) ) {
+		$hostname_value .= ":$port";
+	}
+	$password_value = '';
+	if ( defined( 'FTP_PASS' ) ) {
+		$password_value = '*****';
+	}
+	?>
+</p>
 <label for="hostname">
-	<span class="field-title"><?php _e( 'Hostname' ) ?></span>
+	<span class="field-title"><?php _e( 'Hostname' ); ?></span>
-	<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') ); ?> />
+	<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 $hostname_value; ?>"<?php disabled( defined( 'FTP_HOST' ) ); ?> />
 </label>
 <div class="ftp-username">
 	<label for="username">
 		<span class="field-title"><?php echo $label_user; ?></span>
-		<input name="username" type="text" id="username" value="<?php echo esc_attr($username) ?>"<?php disabled( defined('FTP_USER') ); ?> />
+		<input name="username" type="text" id="username" value="<?php echo esc_attr( $username ); ?>"<?php disabled( defined( 'FTP_USER' ) ); ?> />
 	</label>
 </div>
 <div class="ftp-password">
 	<label for="password">
 		<span class="field-title"><?php echo $label_pass; ?></span>
-		<input name="password" type="password" id="password" value="<?php if ( defined('FTP_PASS') ) echo '*****'; ?>"<?php disabled( defined('FTP_PASS') ); ?> />
+		<input name="password" type="password" id="password" value="<?php echo $password_value; ?>"<?php disabled( defined( 'FTP_PASS' ) ); ?> />
-		<em><?php if ( ! defined('FTP_PASS') ) _e( 'This password will not be stored on the server.' ); ?></em>
+		<em>
+		<?php
+		if ( ! defined( 'FTP_PASS' ) ) {
+			_e( 'This password will not be stored on the server.' );}
+		?>
+</em>
 	</label>
 </div>
 <fieldset>
 <legend><?php _e( 'Connection Type' ); ?></legend>
-<?php
+	<?php
 	$disabled = disabled( ( defined( 'FTP_SSL' ) && FTP_SSL ) || ( defined( 'FTP_SSH' ) && FTP_SSH ), true, false );
-	foreach ( $types as $name => $text ) : ?>
+	foreach ( $types as $name => $text ) :
-	<label for="<?php echo esc_attr( $name ) ?>">
+		?>
-		<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; ?> />
+	<label for="<?php echo esc_attr( $name ); ?>">
+		<input type="radio" name="connection_type" id="<?php echo esc_attr( $name ); ?>" value="<?php echo esc_attr( $name ); ?>" <?php checked( $name, $connection_type ); ?> <?php echo $disabled; ?> />
 		<?php echo $text; ?>
 	</label>
-<?php
+		<?php
 	endforeach;
-?>
+	?>
 </fieldset>
-<?php
+	<?php
-if ( isset( $types['ssh'] ) ) {
+	if ( isset( $types['ssh'] ) ) {
-	$hidden_class = '';
+		$hidden_class = '';
-	if ( 'ssh' != $connection_type || empty( $connection_type ) ) {
+		if ( 'ssh' != $connection_type || empty( $connection_type ) ) {
-		$hidden_class = ' class="hidden"';
+			$hidden_class = ' class="hidden"';
-	}
+		}
-?>
+		?>
 <fieldset id="ssh-keys"<?php echo $hidden_class; ?>>
 <legend><?php _e( 'Authentication Keys' ); ?></legend>
 <label for="public_key">
-	<span class="field-title"><?php _e('Public Key:') ?></span>
+	<span class="field-title"><?php _e( 'Public Key:' ); ?></span>
-	<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') ); ?> />
+	<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' ) ); ?> />
 </label>
 <label for="private_key">
-	<span class="field-title"><?php _e('Private Key:') ?></span>
+	<span class="field-title"><?php _e( 'Private Key:' ); ?></span>
-	<input name="private_key" type="text" id="private_key" value="<?php echo esc_attr($private_key) ?>"<?php disabled( defined('FTP_PRIKEY') ); ?> />
+	<input name="private_key" type="text" id="private_key" value="<?php echo esc_attr( $private_key ); ?>"<?php disabled( defined( 'FTP_PRIKEY' ) ); ?> />
 </label>
-<p 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.' ) ?></p>
+<p 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.' ); ?></p>
 </fieldset>
-<?php
+		<?php
-}
+	}
-foreach ( (array) $extra_fields as $field ) {
+	foreach ( (array) $extra_fields as $field ) {
-	if ( isset( $submitted_form[ $field ] ) )
+		if ( isset( $submitted_form[ $field ] ) ) {
-		echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( $submitted_form[ $field ] ) . '" />';
+			echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( $submitted_form[ $field ] ) . '" />';
-}
+		}
-?>
+	}
+	?>
 	<p class="request-filesystem-credentials-action-buttons">
 		<?php wp_nonce_field( 'filesystem-credentials', '_fs_nonce', false, true ); ?>
 		<button class="button cancel-button" data-js-action="close" type="button"><?php _e( 'Cancel' ); ?></button>
 		<?php submit_button( __( 'Proceed' ), '', 'upgrade', false ); ?>
 	</p>
 </div>
 </form>
-<?php
+	<?php
 	return false;
 }
 /**
 * Print the filesystem credentials modal when needed.
 *     }
 * }
 * @return string The HTML for this group and its items.
 */
 function wp_privacy_generate_personal_data_export_group_html( $group_data ) {
-	$allowed_tags      = array(
+	$group_html  = '<h2>' . esc_html( $group_data['group_label'] ) . '</h2>';
-		'a' => array(
-			'href'   => array(),
-			'target' => array()
-		),
-		'br' => array()
-	);
-	$allowed_protocols = array( 'http', 'https' );
-	$group_html        = '';
-	$group_html .= '<h2>' . esc_html( $group_data['group_label'] ) . '</h2>';
 	$group_html .= '<div>';
 	foreach ( (array) $group_data['items'] as $group_item_id => $group_item_data ) {
 		$group_html .= '<table>';
 		$group_html .= '<tbody>';
 		foreach ( (array) $group_item_data as $group_item_datum ) {
 			$value = $group_item_datum['value'];
-			// If it looks like a link, make it a link
+			// If it looks like a link, make it a link.
 			if ( false === strpos( $value, ' ' ) && ( 0 === strpos( $value, 'http://' ) || 0 === strpos( $value, 'https://' ) ) ) {
 				$value = '<a href="' . esc_url( $value ) . '">' . esc_html( $value ) . '</a>';
 			}
 			$group_html .= '<tr>';
 			$group_html .= '<th>' . esc_html( $group_item_datum['name'] ) . '</th>';
-			$group_html .= '<td>' . wp_kses( $value, $allowed_tags, $allowed_protocols ) . '</td>';
+			$group_html .= '<td>' . wp_kses( $value, 'personal_data_export' ) . '</td>';
 			$group_html .= '</tr>';
 		}
 		$group_html .= '</tbody>';
 		$group_html .= '</table>';
 	$stripped_email       = sanitize_title( $stripped_email ); // slugify the email address
 	$obscura              = wp_generate_password( 32, false, false );
 	$file_basename        = 'wp-personal-data-file-' . $stripped_email . '-' . $obscura;
 	$html_report_filename = $file_basename . '.html';
 	$html_report_pathname = wp_normalize_path( $exports_dir . $html_report_filename );
-	$file = fopen( $html_report_pathname, 'w' );
+	$file                 = fopen( $html_report_pathname, 'w' );
 	if ( false === $file ) {
 		wp_send_json_error( __( 'Unable to open export file (HTML report) for writing.' ) );
 	}
 	$title = sprintf(
-		/* translators: %s: user's e-mail address */
+		/* translators: %s: user's email address */
 		__( 'Personal Data Export for %s' ),
 		$email_address
 	);
 	// Open HTML.
 	// Head.
 	fwrite( $file, "<head>\n" );
 	fwrite( $file, "<meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />\n" );
 	fwrite( $file, "<style type='text/css'>" );
-	fwrite( $file, "body { color: black; font-family: Arial, sans-serif; font-size: 11pt; margin: 15px auto; width: 860px; }" );
+	fwrite( $file, 'body { color: black; font-family: Arial, sans-serif; font-size: 11pt; margin: 15px auto; width: 860px; }' );
-	fwrite( $file, "table { background: #f0f0f0; border: 1px solid #ddd; margin-bottom: 20px; width: 100%; }" );
+	fwrite( $file, 'table { background: #f0f0f0; border: 1px solid #ddd; margin-bottom: 20px; width: 100%; }' );
-	fwrite( $file, "th { padding: 5px; text-align: left; width: 20%; }" );
+	fwrite( $file, 'th { padding: 5px; text-align: left; width: 20%; }' );
-	fwrite( $file, "td { padding: 5px; }" );
+	fwrite( $file, 'td { padding: 5px; }' );
-	fwrite( $file, "tr:nth-child(odd) { background-color: #fafafa; }" );
+	fwrite( $file, 'tr:nth-child(odd) { background-color: #fafafa; }' );
-	fwrite( $file, "</style>" );
+	fwrite( $file, '</style>' );
-	fwrite( $file, "<title>" );
+	fwrite( $file, '<title>' );
 	fwrite( $file, esc_html( $title ) );
-	fwrite( $file, "</title>" );
+	fwrite( $file, '</title>' );
 	fwrite( $file, "</head>\n" );
 	// Body.
 	fwrite( $file, "<body>\n" );
 	// Heading.
-	fwrite( $file, "<h1>" . esc_html__( 'Personal Data Export' ) . "</h1>" );
+	fwrite( $file, '<h1>' . esc_html__( 'Personal Data Export' ) . '</h1>' );
 	// And now, all the Groups.
 	$groups = get_post_meta( $request_id, '_export_data_grouped', true );
 	// First, build an "About" group on the fly for this report.
 function wp_privacy_send_personal_data_export_email( $request_id ) {
 	// Get the request data.
 	$request = wp_get_user_request_data( $request_id );
 	if ( ! $request || 'export_personal_data' !== $request->action_name ) {
-		return new WP_Error( 'invalid', __( 'Invalid request ID when sending personal data export email.' ) );
+		return new WP_Error( 'invalid_request', __( 'Invalid request ID when sending personal data export email.' ) );
 	}
+	// Localize message content for user; fallback to site default for visitors.
+	if ( ! empty( $request->user_id ) ) {
+		$locale = get_user_locale( $request->user_id );
+	} else {
+		$locale = get_locale();
+	}
+	$switched_locale = switch_to_locale( $locale );
 	/** This filter is documented in wp-includes/functions.php */
 	$expiration      = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
 	$expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration );
-/* translators: Do not translate EXPIRATION, LINK, SITENAME, SITEURL: those are placeholders. */
+	/* translators: Do not translate EXPIRATION, LINK, SITENAME, SITEURL: those are placeholders. */
-$email_text = __(
+	$email_text = __(
-'Howdy,
+		'Howdy,
 Your request for an export of personal data has been completed. You may
 download your personal data by clicking on the link below. For privacy
 and security, we will automatically delete the file on ###EXPIRATION###,
 so please download it before then.
 ###LINK###
 Regards,
 All at ###SITENAME###
 ###SITEURL###'
-);
+	);
 	/**
 	 * Filters the text of the email sent with a personal data export file.
 	 *
 	 * The following strings have a special meaning and will get replaced dynamically:
 	 * @param string $email_text     Text in the email.
 	 * @param int    $request_id     The request ID for this personal data export.
 	 */
 	$content = apply_filters( 'wp_privacy_personal_data_email_content', $email_text, $request_id );
-	$email_address = $request->email;
+	$email_address   = $request->email;
 	$export_file_url = get_post_meta( $request_id, '_export_file_url', true );
-	$site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
+	$site_name       = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
-	$site_url = home_url();
+	$site_url        = home_url();
 	$content = str_replace( '###EXPIRATION###', $expiration_date, $content );
 	$content = str_replace( '###LINK###', esc_url_raw( $export_file_url ), $content );
 	$content = str_replace( '###EMAIL###', $email_address, $content );
 	$content = str_replace( '###SITENAME###', $site_name, $content );
 	$content = str_replace( '###SITEURL###', esc_url_raw( $site_url ), $content );
 	$mail_success = wp_mail(
 		$email_address,
 		sprintf(
+			/* translators: Personal data export notification email subject. %s: Site title */
 			__( '[%s] Personal Data Export' ),
 			$site_name
 		),
 		$content
 	);
+	if ( $switched_locale ) {
+		restore_previous_locale();
+	}
 	if ( ! $mail_success ) {
-		return new WP_Error( 'error', __( 'Unable to send personal data export email.' ) );
+		return new WP_Error( 'privacy_email_error', __( 'Unable to send personal data export email.' ) );
 	}
 	return true;
 }
 	$export_data = array_merge( $export_data, $response['data'] );
 	update_post_meta( $request_id, '_export_data_raw', $export_data );
 	// If we are not yet on the last page of the last exporter, return now.
 	/** This filter is documented in wp-admin/includes/ajax-actions.php */
-	$exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
+	$exporters        = apply_filters( 'wp_privacy_personal_data_exporters', array() );
 	$is_last_exporter = $exporter_index === count( $exporters );
-	$exporter_done = $response['done'];
+	$exporter_done    = $response['done'];
 	if ( ! $is_last_exporter || ! $exporter_done ) {
 		return $response;
 	}
 	// Last exporter, last page - let's prepare the export file.
 		$item_id = $export_datum['item_id'];
 		if ( ! array_key_exists( $item_id, $groups[ $group_id ]['items'] ) ) {
 			$groups[ $group_id ]['items'][ $item_id ] = array();
 		}
-		$old_item_data = $groups[ $group_id ]['items'][ $item_id ];
+		$old_item_data                            = $groups[ $group_id ]['items'][ $item_id ];
-		$merged_item_data = array_merge( $export_datum['data'], $old_item_data );
+		$merged_item_data                         = array_merge( $export_datum['data'], $old_item_data );
 		$groups[ $group_id ]['items'][ $item_id ] = $merged_item_data;
 	}
 	// Then save the grouped data into the request.
 	delete_post_meta( $request_id, '_export_data_raw' );
 	if ( $send_as_email ) {
 		$mail_success = wp_privacy_send_personal_data_export_email( $request_id );
 		if ( is_wp_error( $mail_success ) ) {
 			wp_send_json_error( $mail_success->get_error_message() );
 		}
+		// Update the request to completed state when the export email is sent.
+		_wp_privacy_completed_request( $request_id );
 	} else {
 		// Modify the response to include the URL of the export file so the browser can fetch it.
 		$export_file_url = get_post_meta( $request_id, '_export_file_url', true );
 		if ( ! empty( $export_file_url ) ) {
 			$response['url'] = $export_file_url;
 		}
 	}
-	// Update the request to completed state.
-	_wp_privacy_completed_request( $request_id );
 	return $response;
 }

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4