php-wordpress-wordpress-whitespace-only-change

A painting is a person's account of this edit as text, recorded independently of the node mapping - a rendering often has several equally defensible answers where the mapping has one. Deletions and insertions carry no position on the opposite side in a painting, so that panel draws no caret for them.

Before1<?php
2/**
* Filesystem API: Top-level functionality
*
* Functions for reading, writing, modifying, and deleting files on the file system.
* Includes functionality for theme-specific files as well as operations for uploading,
* archiving, and rendering output when necessary.
*
* @package WordPress
* @subpackage Filesystem
* @since 2.3.0
*/
13
14/** The descriptions for theme files. */
15$wp_file_descriptions = array(
'functions.php'         => __( 'Theme Functions' ),
'header.php'            => __( 'Theme Header' ),
'footer.php'            => __( 'Theme Footer' ),
'sidebar.php'           => __( 'Sidebar' ),
'comments.php'          => __( 'Comments' ),
'searchform.php'        => __( 'Search Form' ),
'404.php'               => __( '404 Template' ),
'link.php'              => __( 'Links Template' ),
'theme.json'            => __( 'Theme Styles & Block Settings' ),
// Archives.
'index.php'             => __( 'Main Index Template' ),
'archive.php'           => __( 'Archives' ),
'author.php'            => __( 'Author Template' ),
'taxonomy.php'          => __( 'Taxonomy Template' ),
'category.php'          => __( 'Category Template' ),
'tag.php'               => __( 'Tag Template' ),
'home.php'              => __( 'Posts Page' ),
'search.php'            => __( 'Search Results' ),
'date.php'              => __( 'Date Template' ),
// 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' ),
'application.php'       => __( 'Application Attachment Template' ),
// Embeds.
'embed.php'             => __( 'Embed Template' ),
'embed-404.php'         => __( 'Embed 404 Template' ),
'embed-content.php'     => __( 'Embed Content Template' ),
'header-embed.php'      => __( 'Embed Header Template' ),
'footer-embed.php'      => __( 'Embed Footer Template' ),
// Stylesheets.
'style.css'             => __( 'Stylesheet' ),
'editor-style.css'      => __( 'Visual Editor Stylesheet' ),
'editor-style-rtl.css'  => __( 'Visual Editor RTL Stylesheet' ),
'rtl.css'               => __( 'RTL Stylesheet' ),
// Other.
'my-hacks.php'          => __( 'my-hacks.php (legacy hacks support)' ),
'.htaccess'             => __( '.htaccess (for rewrite rules )' ),
// Deprecated files.
'wp-layout.css'         => __( 'Stylesheet' ),
'wp-comments.php'       => __( 'Comments Template' ),
'wp-comments-popup.php' => __( 'Popup Comments Template' ),
'comments-popup.php'    => __( 'Popup Comments' ),
66);
67
68/**
* Gets the description for standard WordPress theme files.
*
* @since 1.5.0
*
* @global array $wp_file_descriptions Theme file descriptions.
* @global array $allowed_files        List of allowed files.
*
* @param string $file Filesystem path or filename.
* @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist.
*                Appends 'Page Template' to basename of $file if the file is a page template.
*/
80function get_file_description( $file ) {
global $wp_file_descriptions, $allowed_files;
82
$dirname   = pathinfo( $file, PATHINFO_DIRNAME );
$file_path = $allowed_files[ $file ];
85
if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) {
return $wp_file_descriptions[ basename( $file ) ];
} elseif ( file_exists( $file_path ) && is_file( $file_path ) ) {
$template_data = implode( '', file( $file_path ) );
90
if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) {
	/* translators: %s: Template name. */
	return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
}
}
96
return trim( basename( $file ) );
98}
99
100/**
* Gets the absolute filesystem path to the root of the WordPress installation.
*
* @since 1.5.0
*
* @return string Full filesystem path to the root of the WordPress installation.
*/
107function get_home_path() {
$home    = set_url_scheme( get_option( 'home' ), 'http' );
$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );
110
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 ) );
$home_path           = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
$home_path           = trailingslashit( $home_path );
} else {
$home_path = ABSPATH;
}
119
return str_replace( '\\', '/', $home_path );
121}
122
123/**
* Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
*
* The depth of the recursiveness can be controlled by the $levels param.
*
* @since 2.6.0
* @since 4.9.0 Added the `$exclusions` parameter.
* @since 6.3.0 Added the `$include_hidden` parameter.
*
* @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 string[] $exclusions     Optional. List of folders and files to skip.
* @param bool     $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
*                                 Default false.
* @return string[]|false Array of files on success, false on failure.
*/
139function list_files( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false ) {
if ( empty( $folder ) ) {
return false;
}
143
$folder = trailingslashit( $folder );
145
if ( ! $levels ) {
return false;
}
149
$files = array();
151
$dir = @opendir( $folder );
153
if ( $dir ) {
while ( ( $file = readdir( $dir ) ) !== false ) {
	// Skip current and parent folder links.
	if ( in_array( $file, array( '.', '..' ), true ) ) {
		continue;
	}
160
	// Skip hidden and excluded files.
	if ( ( ! $include_hidden && '.' === $file[0] ) || in_array( $file, $exclusions, true ) ) {
		continue;
	}
165
	if ( is_dir( $folder . $file ) ) {
		$files2 = list_files( $folder . $file, $levels - 1, array(), $include_hidden );
		if ( $files2 ) {
			$files = array_merge( $files, $files2 );
		} else {
			$files[] = $folder . $file . '/';
		}
	} else {
		$files[] = $folder . $file;
	}
}
177
closedir( $dir );
}
180
return $files;
182}
183
184/**
* Gets the list of file extensions that are editable in plugins.
*
* @since 4.9.0
*
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return string[] Array of editable file extensions.
*/
192function wp_get_plugin_file_editable_extensions( $plugin ) {
193
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
228
/**
* Filters the list of file types allowed for editing in the plugin file editor.
*
* @since 2.8.0
* @since 4.9.0 Added the `$plugin` parameter.
*
* @param string[] $default_types An array of editable plugin file extensions.
* @param string   $plugin        Path to the plugin file relative to the plugins directory.
*/
$file_types = (array) apply_filters( 'editable_extensions', $default_types, $plugin );
239
return $file_types;
241}
242
243/**
* Gets the list of file extensions that are editable for a given theme.
*
* @since 4.9.0
*
* @param WP_Theme $theme Theme object.
* @return string[] Array of editable file extensions.
*/
251function wp_get_theme_file_editable_extensions( $theme ) {
252
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
287
/**
* Filters the list of file types allowed for editing in the theme file editor.
*
* @since 4.4.0
*
* @param string[] $default_types An array of editable theme file extensions.
* @param WP_Theme $theme         The active theme object.
*/
$file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme );
297
// Ensure that default types are still there.
return array_unique( array_merge( $file_types, $default_types ) );
300}
301
302/**
* Prints file editor templates (for plugins and themes).
*
* @since 4.9.0
*/
307function wp_print_file_editor_templates() {
?>
<script type="text/html" id="tmpl-wp-file-editor-notice">
<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: 1: Line number, 2: File path. */
				__( 'Your PHP code changes were not applied due to an error on line %1$s of file %2$s. Please fix and try saving again.' ),
				'{{ data.line }}',
				'{{ data.file }}'
			);
			?>
		</p>
		<pre>{{ data.message }}</pre>
	<# } else if ( 'file_not_writable' === data.code ) { #>
		<p>
			<?php
			printf(
				/* translators: %s: Documentation URL. */
				__( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ),
				__( 'https://developer.wordpress.org/advanced-administration/server/file-permissions/' )
			);
			?>
		</p>
	<# } else { #>
		<p>{{ data.message || data.code }}</p>
335
		<# if ( 'lint_errors' === data.code ) { #>
			<p>
				<# var elementId = 'el-' + String( Math.random() ); #>
				<input id="{{ elementId }}"  type="checkbox">
				<label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label>
			</p>
		<# } #>
	<# } #>
	<# if ( data.dismissible ) { #>
		<button type="button" class="notice-dismiss"><span class="screen-reader-text">
			<?php
			/* translators: Hidden accessibility text. */
			_e( 'Dismiss' );
			?>
		</span></button>
	<# } #>
</div>
</script>
<?php
355}
356
357/**
* Attempts to edit a file for a theme or plugin.
*
* When editing a PHP file, loopback requests will be made to the admin and the homepage
* to attempt to see if there is a fatal error introduced. If so, the PHP change will be
* reverted.
*
* @since 4.9.0
*
* @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.
*
*     @type string $file       Relative path to file.
*     @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.
*/
378function wp_edit_theme_plugin_file( $args ) {
if ( empty( $args['file'] ) ) {
return new WP_Error( 'missing_file' );
}
382
if ( 0 !== validate_file( $args['file'] ) ) {
return new WP_Error( 'bad_file' );
}
386
if ( ! isset( $args['newcontent'] ) ) {
return new WP_Error( 'missing_content' );
}
390
if ( ! isset( $args['nonce'] ) ) {
return new WP_Error( 'missing_nonce' );
}
394
$file    = $args['file'];
$content = $args['newcontent'];
397
$plugin    = null;
$theme     = null;
$real_file = null;
401
if ( ! empty( $args['plugin'] ) ) {
$plugin = $args['plugin'];
404
if ( ! current_user_can( 'edit_plugins' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit plugins for this site.' ) );
}
408
if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
412
if ( ! array_key_exists( $plugin, get_plugins() ) ) {
	return new WP_Error( 'invalid_plugin' );
}
416
if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {
	return new WP_Error( 'bad_plugin_file_path', __( 'Sorry, that file cannot be edited.' ) );
}
420
$editable_extensions = wp_get_plugin_file_editable_extensions( $plugin );
422
$real_file = WP_PLUGIN_DIR . '/' . $file;
424
$is_active = in_array(
	$plugin,
	(array) get_option( 'active_plugins', array() ),
	true
);
430
} elseif ( ! empty( $args['theme'] ) ) {
$stylesheet = $args['theme'];
433
if ( 0 !== validate_file( $stylesheet ) ) {
	return new WP_Error( 'bad_theme_path' );
}
437
if ( ! current_user_can( 'edit_themes' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit templates for this site.' ) );
}
441
$theme = wp_get_theme( $stylesheet );
if ( ! $theme->exists() ) {
	return new WP_Error( 'non_existent_theme', __( 'The requested theme does not exist.' ) );
}
446
if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
450
if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) {
	return new WP_Error(
		'theme_no_stylesheet',
		__( 'The requested theme does not exist.' ) . ' ' . $theme->errors()->get_error_message()
	);
}
457
$editable_extensions = wp_get_theme_file_editable_extensions( $theme );
459
$allowed_files = array();
foreach ( $editable_extensions as $type ) {
	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 );
			$allowed_files['style.css'] = $style_files['style.css'];
			$allowed_files              = array_merge( $allowed_files, $style_files );
			break;
		default:
			$allowed_files = array_merge( $allowed_files, $theme->get_files( $type, -1 ) );
			break;
	}
}
476
// 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.' ) );
}
481
$real_file = $theme->get_stylesheet_directory() . '/' . $file;
483
$is_active = ( get_stylesheet() === $stylesheet || get_template() === $stylesheet );
485
} else {
return new WP_Error( 'missing_theme_or_plugin' );
}
489
// Ensure file is real.
if ( ! is_file( $real_file ) ) {
return new WP_Error( 'file_does_not_exist', __( 'File does not exist! Please double check the name and try again.' ) );
}
494
// Ensure file extension is allowed.
$extension = null;
if ( preg_match( '/\.([^.]+)$/', $real_file, $matches ) ) {
$extension = strtolower( $matches[1] );
if ( ! in_array( $extension, $editable_extensions, true ) ) {
	return new WP_Error( 'illegal_file_type', __( 'Files of this type are not editable.' ) );
}
}
503
$previous_content = file_get_contents( $real_file );
505
if ( ! is_writable( $real_file ) ) {
return new WP_Error( 'file_not_writable' );
}
509
$f = fopen( $real_file, 'w+' );
511
if ( false === $f ) {
return new WP_Error( 'file_not_writable' );
}
515
$written = fwrite( $f, $content );
fclose( $f );
518
if ( false === $written ) {
return new WP_Error( 'unable_to_write', __( 'Unable to write to file.' ) );
}
522
wp_opcache_invalidate( $real_file, true );
524
if ( $is_active && 'php' === $extension ) {
526
$scrape_key   = md5( rand() );
$transient    = 'scrape_key_' . $scrape_key;
$scrape_nonce = (string) rand();
// It shouldn't take more than 60 seconds to make the two loopback requests.
set_transient( $transient, $scrape_nonce, 60 );
532
$cookies       = wp_unslash( $_COOKIE );
$scrape_params = array(
	'wp_scrape_key'   => $scrape_key,
	'wp_scrape_nonce' => $scrape_nonce,
);
$headers       = array(
	'Cache-Control' => 'no-cache',
);
541
/** This filter is documented in wp-includes/class-wp-http-streams.php */
$sslverify = apply_filters( 'https_local_ssl_verify', false );
544
// Include Basic auth in loopback requests.
if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
	$headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );
}
549
// Make sure PHP process doesn't die before loopback requests complete.
if ( function_exists( 'set_time_limit' ) ) {
	set_time_limit( 5 * MINUTE_IN_SECONDS );
}
554
// Time to wait for loopback requests to finish.
$timeout = 100; // 100 seconds.
557
$needle_start = "###### wp_scraping_result_start:$scrape_key ######";
$needle_end   = "###### wp_scraping_result_end:$scrape_key ######";
560
// 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,
		),
		admin_url( 'theme-editor.php' )
	);
} else {
	$url = admin_url();
}
575
if ( function_exists( 'session_status' ) && PHP_SESSION_ACTIVE === session_status() ) {
	/*
	 * Close any active session to prevent HTTP requests from timing out
	 * when attempting to connect back to the site.
	 */
	session_write_close();
}
583
$url                    = add_query_arg( $scrape_params, $url );
$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
$body                   = wp_remote_retrieve_body( $r );
$scrape_result_position = strpos( $body, $needle_start );
588
$loopback_request_failure = array(
	'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(
	'code' => 'json_parse_error',
);
596
$result = null;
598
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 );
	if ( empty( $result ) ) {
		$result = $json_parse_failure;
	}
}
609
// Try making request to homepage as well to see if visitors have been whitescreened.
if ( true === $result ) {
	$url                    = home_url( '/' );
	$url                    = add_query_arg( $scrape_params, $url );
	$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
	$body                   = wp_remote_retrieve_body( $r );
	$scrape_result_position = strpos( $body, $needle_start );
617
	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 );
		if ( empty( $result ) ) {
			$result = $json_parse_failure;
		}
	}
}
629
delete_transient( $transient );
631
if ( true !== $result ) {
	// Roll-back file change.
	file_put_contents( $real_file, $previous_content );
	wp_opcache_invalidate( $real_file, true );
636
	if ( ! isset( $result['message'] ) ) {
		$message = __( 'An error occurred. Please try again later.' );
	} else {
		$message = $result['message'];
		unset( $result['message'] );
	}
643
	return new WP_Error( 'php_error', $message, $result );
}
}
647
if ( $theme instanceof WP_Theme ) {
$theme->cache_delete();
}
651
return true;
653}
654
655
656/**
* Returns a filename of a temporary unique file.
*
* Please note that the calling function must delete or move the file.
*
* The filename is based off the passed parameter or defaults to the current unix timestamp,
* while the directory can either be passed as well, or by leaving it blank, default to a writable
* temporary directory.
*
* @since 2.6.0
*
* @param string $filename Optional. Filename to base the Unique file off. Default empty.
* @param string $dir      Optional. Directory to store the file in. Default empty.
* @return string A writable filename.
*/
671function wp_tempnam( $filename = '', $dir = '' ) {
if ( empty( $dir ) ) {
$dir = get_temp_dir();
}
675
if ( empty( $filename ) || in_array( $filename, array( '.', '/', '\\' ), true ) ) {
$filename = uniqid();
}
679
// 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 );
683
// If the folder is falsey, use its parent directory name instead.
if ( ! $temp_filename ) {
return wp_tempnam( dirname( $filename ), $dir );
}
688
// Suffix some random data to avoid filename conflicts.
$temp_filename .= '-' . wp_generate_password( 6, false );
$temp_filename .= '.tmp';
$temp_filename  = wp_unique_filename( $dir, $temp_filename );
693
/*
* Filesystems typically have a limit of 255 characters for a filename.
*
* If the generated unique filename exceeds this, truncate the initial
* filename and try again.
*
* As it's possible that the truncated filename may exist, producing a
* suffix of "-1" or "-10" which could exceed the limit again, truncate
* it to 252 instead.
*/
$characters_over_limit = strlen( $temp_filename ) - 252;
if ( $characters_over_limit > 0 ) {
$filename = substr( $filename, 0, -$characters_over_limit );
return wp_tempnam( $filename, $dir );
}
709
$temp_filename = $dir . $temp_filename;
711
$fp = @fopen( $temp_filename, 'x' );
713
if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) {
return wp_tempnam( $filename, $dir );
}
717
if ( $fp ) {
fclose( $fp );
}
721
return $temp_filename;
723}
724
725/**
* Makes sure that the file that was requested to be edited is allowed to be edited.
*
* 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[] $allowed_files Optional. Array of allowed files to edit.
*                                `$file` must match an entry exactly.
* @return string|void Returns the file name on success, dies on failure.
*/
737function validate_file_to_edit( $file, $allowed_files = array() ) {
$code = validate_file( $file, $allowed_files );
739
if ( ! $code ) {
return $file;
}
743
switch ( $code ) {
case 1:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
747
	// case 2 :
	// wp_die( __('Sorry, cannot call files with their real path.' ));
750
case 3:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
}
754}
755
756/**
* Handles PHP uploads in WordPress.
*
* Sanitizes file names, checks extensions for mime type, and moves the file
* to the appropriate directory within the uploads directory.
*
* @access private
* @since 4.0.0
*
* @see wp_handle_upload_error
*
* @param array       $file      {
*     Reference to a single element from `$_FILES`. Call the function once for each uploaded file.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param array|false $overrides {
*     An array of override parameters for this file, or boolean false if none are provided.
*
*     @type callable $upload_error_handler     Function to call when there is an error during the upload process.
*                                              See {@see wp_handle_upload_error()}.
*     @type callable $unique_filename_callback Function to call when determining a unique file name for the file.
*                                              See {@see wp_unique_filename()}.
*     @type string[] $upload_error_strings     The strings that describe the error indicated in
*                                              `$_FILES[{form field}]['error']`.
*     @type bool     $test_form                Whether to test that the `$_POST['action']` parameter is as expected.
*     @type bool     $test_size                Whether to test that the file size is greater than zero bytes.
*     @type bool     $test_type                Whether to test that the mime type of the file is as expected.
*     @type string[] $mimes                    Array of allowed mime types keyed by their file extension regex.
* }
* @param string      $time      Time formatted in 'yyyy/mm'.
* @param string      $action    Expected value for `$_POST['action']`.
* @return array {
*     On success, returns an associative array of file attributes.
*     On failure, returns `$overrides['upload_error_handler']( &$file, $message )`
*     or `array( 'error' => $message )`.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
*/
802function _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 ) {
	return array( 'error' => $message );
}
}
809
/**
* Filters the data for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_prefilter`
*  - `wp_handle_upload_prefilter`
*
* @since 2.9.0 as 'wp_handle_upload_prefilter'.
* @since 4.0.0 Converted to a dynamic hook with `$action`.
*
* @param array $file {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$file = apply_filters( "{$action}_prefilter", $file );
834
/**
* Filters the override parameters for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_overrides`
*  - `wp_handle_upload_overrides`
*
* @since 5.7.0
*
* @param array|false $overrides An array of override parameters for this file. Boolean false if none are
*                               provided. See {@see _wp_handle_upload()}.
* @param array       $file      {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$overrides = apply_filters( "{$action}_overrides", $overrides, $file );
860
// You may define your own function and pass the name in $overrides['upload_error_handler'].
$upload_error_handler = 'wp_handle_upload_error';
if ( isset( $overrides['upload_error_handler'] ) ) {
$upload_error_handler = $overrides['upload_error_handler'];
}
866
// You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully.
if ( isset( $file['error'] ) && ! is_numeric( $file['error'] ) && $file['error'] ) {
return call_user_func_array( $upload_error_handler, array( &$file, $file['error'] ) );
}
871
// Install user overrides. Did we mention that this voids your warranty?
873
// You may define your own function and pass the name in $overrides['unique_filename_callback'].
$unique_filename_callback = null;
if ( isset( $overrides['unique_filename_callback'] ) ) {
$unique_filename_callback = $overrides['unique_filename_callback'];
}
879
/*
* This may not have originally been intended to be overridable,
* but historically has been.
*/
if ( isset( $overrides['upload_error_strings'] ) ) {
$upload_error_strings = $overrides['upload_error_strings'];
} else {
// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
$upload_error_strings = array(
	false,
	sprintf(
		/* translators: 1: upload_max_filesize, 2: php.ini */
		__( 'The uploaded file exceeds the %1$s directive in %2$s.' ),
		'upload_max_filesize',
		'php.ini'
	),
	sprintf(
		/* translators: %s: MAX_FILE_SIZE */
		__( 'The uploaded file exceeds the %s directive that was specified in the HTML form.' ),
		'MAX_FILE_SIZE'
	),
	__( '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.' ),
);
}
909
// 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;
913
// 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'] : null;
917
// 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.' ) ) );
}
922
// 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'] ] ) );
}
927
// 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.' ) ) );
}
933
$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 ) ) {
if ( is_multisite() ) {
	$error_msg = __( 'File is empty. Please upload something more substantial.' );
} else {
	$error_msg = sprintf(
		/* translators: 1: php.ini, 2: post_max_size, 3: upload_max_filesize */
		__( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your %1$s file or by %2$s being defined as smaller than %3$s in %1$s.' ),
		'php.ini',
		'post_max_size',
		'upload_max_filesize'
	);
}
948
return call_user_func_array( $upload_error_handler, array( &$file, $error_msg ) );
}
951
// 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 );
$ext             = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext'];
$type            = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type'];
$proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename'];
958
// Check to see if wp_check_filetype_and_ext() determined the filename was incorrect.
if ( $proper_filename ) {
	$file['name'] = $proper_filename;
}
963
if ( ( ! $type || ! $ext ) && ! current_user_can( 'unfiltered_upload' ) ) {
	return call_user_func_array( $upload_error_handler, array( &$file, __( 'Sorry, you are not allowed to upload this file type.' ) ) );
}
967
if ( ! $type ) {
	$type = $file['type'];
}
} else {
$type = '';
}
974
/*
* A writable uploads dir will pass this test. Again, there's no point
* overriding this one.
*/
$uploads = wp_upload_dir( $time );
if ( ! ( $uploads && false === $uploads['error'] ) ) {
return call_user_func_array( $upload_error_handler, array( &$file, $uploads['error'] ) );
}
983
$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
985
// Move the file to the uploads dir.
$new_file = $uploads['path'] . "/$filename";
988
/**
* Filters whether to short-circuit moving the uploaded file after passing all checks.
*
* If a non-null value is returned from the filter, moving the file and any related
* error reporting will be completely skipped.
*
* @since 4.9.0
*
* @param mixed    $move_new_file If null (default) move the file after the upload.
* @param array    $file          {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param string   $new_file      Filename of the newly-uploaded file.
* @param string   $type          Mime type of the newly-uploaded file.
*/
$move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type );
1011
if ( null === $move_new_file ) {
if ( 'wp_handle_upload' === $action ) {
	$move_new_file = @move_uploaded_file( $file['tmp_name'], $new_file );
} else {
	// Use copy and unlink because rename breaks streams.
	// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
	$move_new_file = @copy( $file['tmp_name'], $new_file );
	unlink( $file['tmp_name'] );
}
1021
if ( false === $move_new_file ) {
	if ( str_starts_with( $uploads['basedir'], ABSPATH ) ) {
		$error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
	} else {
		$error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
	}
1028
	return $upload_error_handler(
		$file,
		sprintf(
			/* translators: %s: Destination file path. */
			__( 'The uploaded file could not be moved to %s.' ),
			$error_path
		)
	);
}
}
1039
// Set correct file permissions.
$stat  = stat( dirname( $new_file ) );
$perms = $stat['mode'] & 0000666;
chmod( $new_file, $perms );
1044
// Compute the URL.
$url = $uploads['url'] . "/$filename";
1047
if ( is_multisite() ) {
clean_dirsize_cache( $new_file );
}
1051
/**
* Filters the data array for the uploaded file.
*
* @since 2.1.0
*
* @param array  $upload {
*     Array of upload data.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
* @param string $context The type of upload action. Values include 'upload' or 'sideload'.
*/
return apply_filters(
'wp_handle_upload',
array(
	'file' => $new_file,
	'url'  => $url,
	'type' => $type,
),
'wp_handle_sideload' === $action ? 'sideload' : 'upload'
);
1075}
1076
1077/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_upload'} action.
*
* @since 2.0.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1095function wp_handle_upload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_upload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1104
return _wp_handle_upload( $file, $overrides, $time, $action );
1106}
1107
1108/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_sideload'} action.
*
* @since 2.6.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1126function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_sideload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1135
return _wp_handle_upload( $file, $overrides, $time, $action );
1137}
1138
1139/**
* Downloads a URL to a local temporary file using the WordPress HTTP API.
*
* Please note that the calling function must delete or move the file.
*
* @since 2.5.0
* @since 5.2.0 Signature Verification with SoftFail was added.
* @since 5.9.0 Support for Content-Disposition filename 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 bool   $signature_verification Whether to perform Signature Verification.
*                                       Default false.
* @return string|WP_Error Filename on success, WP_Error on failure.
*/
1155function download_url( $url, $timeout = 300, $signature_verification = false ) {
// WARNING: The file is not automatically deleted, the script must delete or move the file.
if ( ! $url ) {
return new WP_Error( 'http_no_url', __( 'No URL Provided.' ) );
}
1160
$url_path     = parse_url( $url, PHP_URL_PATH );
$url_filename = '';
if ( is_string( $url_path ) && '' !== $url_path ) {
$url_filename = basename( $url_path );
}
1166
$tmpfname = wp_tempnam( $url_filename );
if ( ! $tmpfname ) {
return new WP_Error( 'http_no_file', __( 'Could not create temporary file.' ) );
}
1171
$response = wp_safe_remote_get(
$url,
array(
	'timeout'  => $timeout,
	'stream'   => true,
	'filename' => $tmpfname,
)
);
1180
if ( is_wp_error( $response ) ) {
unlink( $tmpfname );
return $response;
}
1185
$response_code = wp_remote_retrieve_response_code( $response );
1187
if ( 200 !== $response_code ) {
$data = array(
	'code' => $response_code,
);
1192
// Retrieve a sample of the response body for debugging purposes.
$tmpf = fopen( $tmpfname, 'rb' );
1195
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 );
1207
	$data['body'] = fread( $tmpf, $response_size );
	fclose( $tmpf );
}
1211
unlink( $tmpfname );
1213
return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data );
}
1216
$content_disposition = wp_remote_retrieve_header( $response, 'Content-Disposition' );
1218
if ( $content_disposition ) {
$content_disposition = strtolower( $content_disposition );
1221
if ( str_starts_with( $content_disposition, 'attachment; filename=' ) ) {
	$tmpfname_disposition = sanitize_file_name( substr( $content_disposition, 21 ) );
} else {
	$tmpfname_disposition = '';
}
1227
// Potential file name must be valid string.
if ( $tmpfname_disposition && is_string( $tmpfname_disposition )
	&& ( 0 === validate_file( $tmpfname_disposition ) )
) {
	$tmpfname_disposition = dirname( $tmpfname ) . '/' . $tmpfname_disposition;
1233
	if ( rename( $tmpfname, $tmpfname_disposition ) ) {
		$tmpfname = $tmpfname_disposition;
	}
1237
	if ( ( $tmpfname !== $tmpfname_disposition ) && file_exists( $tmpfname_disposition ) ) {
		unlink( $tmpfname_disposition );
	}
}
}
1243
$mime_type = wp_remote_retrieve_header( $response, 'content-type' );
if ( $mime_type && 'tmp' === pathinfo( $tmpfname, PATHINFO_EXTENSION ) ) {
$valid_mime_types = array_flip( get_allowed_mime_types() );
if ( ! empty( $valid_mime_types[ $mime_type ] ) ) {
	$extensions     = explode( '|', $valid_mime_types[ $mime_type ] );
	$new_image_name = substr( $tmpfname, 0, -4 ) . ".{$extensions[0]}";
	if ( 0 === validate_file( $new_image_name ) ) {
		if ( rename( $tmpfname, $new_image_name ) ) {
			$tmpfname = $new_image_name;
		}
1254
		if ( ( $tmpfname !== $new_image_name ) && file_exists( $new_image_name ) ) {
			unlink( $new_image_name );
		}
	}
}
}
1261
$content_md5 = wp_remote_retrieve_header( $response, 'Content-MD5' );
1263
if ( $content_md5 ) {
$md5_check = verify_file_md5( $tmpfname, $content_md5 );
1266
if ( is_wp_error( $md5_check ) ) {
	unlink( $tmpfname );
	return $md5_check;
}
}
1272
// 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 attempted on.
 *
 * @since 5.2.0
 *
 * @param string[] $hostnames List of hostnames.
 */
$signed_hostnames = apply_filters( 'wp_signature_hosts', array( 'wordpress.org', 'downloads.wordpress.org', 's.w.org' ) );
1283
$signature_verification = in_array( parse_url( $url, PHP_URL_HOST ), $signed_hostnames, true );
}
1286
// Perform signature validation if supported.
if ( $signature_verification ) {
$signature = wp_remote_retrieve_header( $response, 'X-Content-Signature' );
1290
if ( ! $signature ) {
	/*
	 * Retrieve signatures from a file if the header wasn't included.
	 * WordPress.org stores signatures at $package_url.sig.
	 */
1296
	$signature_url = false;
1298
	if ( is_string( $url_path ) && ( str_ends_with( $url_path, '.zip' ) || str_ends_with( $url_path, '.tar.gz' ) ) ) {
		$signature_url = str_replace( $url_path, $url_path . '.sig', $url );
	}
1302
	/**
	 * Filters 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 );
1312
	if ( $signature_url ) {
		$signature_request = wp_safe_remote_get(
			$signature_url,
			array(
				'limit_response_size' => 10 * KB_IN_BYTES, // 10KB should be large enough for quite a few signatures.
			)
		);
1320
		if ( ! is_wp_error( $signature_request ) && 200 === wp_remote_retrieve_response_code( $signature_request ) ) {
			$signature = explode( "\n", wp_remote_retrieve_body( $signature_request ) );
		}
	}
}
1326
// Perform the checks.
$signature_verification = verify_file_signature( $tmpfname, $signature, $url_filename );
}
1330
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 );
}
1350
return $signature_verification;
}
1353
return $tmpfname;
1355}
1356
1357/**
* 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 $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5,
*                             or a hex-encoded md5.
* @return bool|WP_Error True on success, false when the MD5 format is unknown/unexpected,
*                       WP_Error on failure.
*/
1368function verify_file_md5( $filename, $expected_md5 ) {
if ( 32 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = pack( 'H*', $expected_md5 );
} elseif ( 24 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = base64_decode( $expected_md5 );
} else {
return false; // Unknown format.
}
1376
$file_md5 = md5_file( $filename, true );
1378
if ( $file_md5 === $expected_raw_md5 ) {
return true;
}
1382
return new WP_Error(
'md5_mismatch',
sprintf(
	/* translators: 1: File checksum, 2: Expected checksum value. */
	__( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ),
	bin2hex( $file_md5 ),
	bin2hex( $expected_raw_md5 )
)
);
1392}
1393
1394/**
* Verifies the contents of a file against its ED25519 signature.
*
* @since 5.2.0
*
* @param string       $filename            The file to validate.
* @param string|array $signatures          A Signature provided for the file.
* @param string|false $filename_for_errors Optional. A friendly filename for errors.
* @return bool|WP_Error True on success, false if verification not attempted,
*                       or WP_Error describing an error condition.
*/
1405function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {
if ( ! $filename_for_errors ) {
$filename_for_errors = wp_basename( $filename );
}
1409
// Check we can process signatures.
if ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) || ! in_array( 'sha384', array_map( 'strtolower', hash_algos() ), true ) ) {
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' )
);
}
1422
// Verify runtime speed of Sodium_Compat is acceptable.
if ( ! extension_loaded( 'sodium' ) && ! ParagonIE_Sodium_Compat::polyfill_is_fast() ) {
$sodium_compat_is_fast = false;
1426
// 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 utilizes during signing verifications.
	 */
	// phpcs:disable WordPress.NamingConventions.ValidVariableName
	$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;
	// phpcs:enable
}
1440
/*
 * 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'                => PHP_VERSION,
			'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' ),
		)
	);
}
}
1462
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,
	)
);
}
1476
$trusted_keys = wp_trusted_keys();
$file_hash    = hash_file( 'sha384', $filename, true );
1479
mbstring_binary_safe_encoding();
1481
$skipped_key       = 0;
$skipped_signature = 0;
1484
foreach ( (array) $signatures as $signature ) {
$signature_raw = base64_decode( $signature );
1487
// Ensure only valid-length signatures are considered.
if ( SODIUM_CRYPTO_SIGN_BYTES !== strlen( $signature_raw ) ) {
	++$skipped_signature;
	continue;
}
1493
foreach ( (array) $trusted_keys as $key ) {
	$key_raw = base64_decode( $key );
1496
	// Only pass valid public keys through.
	if ( SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES !== strlen( $key_raw ) ) {
		++$skipped_key;
		continue;
	}
1502
	if ( sodium_crypto_sign_verify_detached( $signature_raw, $file_hash, $key_raw ) ) {
		reset_mbstring_encoding();
		return true;
	}
}
}
1509
reset_mbstring_encoding();
1511
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'         => PHP_VERSION,
	'sodium'      => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ),
)
);
1531}
1532
1533/**
* Retrieves the list of signing keys trusted by WordPress.
*
* @since 5.2.0
*
* @return string[] Array of base64-encoded signing keys.
*/
1540function wp_trusted_keys() {
$trusted_keys = array();
1542
if ( time() < 1617235200 ) {
// WordPress.org Key #1 - This key is only valid before April 1st, 2021.
$trusted_keys[] = 'fRPyrxb/MvVLbdsYi+OOEv4xc+Eqpsj+kkAS6gNOkI0=';
}
1547
// TODO: Add key #2 with longer expiration.
1549
/**
* Filters the valid signing keys used to verify the contents of files.
*
* @since 5.2.0
*
* @param string[] $trusted_keys The trusted keys that may sign packages.
*/
return apply_filters( 'wp_trusted_keys', $trusted_keys );
1558}
1559
1560/**
* Determines whether the given file is a valid ZIP file.
*
* This function does not test to ensure that a file exists. Non-existent files
* are not valid ZIPs, so those will also return false.
*
* @since 6.4.4
*
* @param string $file Full path to the ZIP file.
* @return bool Whether the file is a valid ZIP file.
*/
1571function wp_zip_file_is_valid( $file ) {
/** This filter is documented in wp-admin/includes/file.php */
if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
$archive          = new ZipArchive();
$archive_is_valid = $archive->open( $file, ZipArchive::CHECKCONS );
if ( true === $archive_is_valid ) {
	$archive->close();
	return true;
}
}
1581
// Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1584
$archive          = new PclZip( $file );
$archive_is_valid = is_array( $archive->properties() );
1587
return $archive_is_valid;
1589}
1590
1591/**
* 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 WordPress filesystem subclass.
*
* @param string $file Full path and filename of ZIP archive.
* @param string $to   Full path on the filesystem to extract archive to.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1609function unzip_file( $file, $to ) {
global $wp_filesystem;
1611
if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) {
return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
}
1615
// Unzip can use a lot of memory, but not this much hopefully.
wp_raise_memory_limit( 'admin' );
1618
$needed_dirs = array();
$to          = trailingslashit( $to );
1621
// Determine any parent directories needed (of the upgrade directory).
if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parents if no children exist.
$path = preg_split( '![/\\\]!', untrailingslashit( $to ) );
for ( $i = count( $path ); $i >= 0; $i-- ) {
	if ( empty( $path[ $i ] ) ) {
		continue;
	}
1629
	$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;
	}
1634
	if ( ! $wp_filesystem->is_dir( $dir ) ) {
		$needed_dirs[] = $dir;
	} else {
		break; // A folder exists, therefore we don't need to check the levels below this.
	}
}
}
1642
/**
* 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 );
if ( true === $result ) {
	return $result;
} elseif ( is_wp_error( $result ) ) {
	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 );
1662}
1663
1664/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1683function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1685
$z = new ZipArchive();
1687
$zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS );
1689
if ( true !== $zopen ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) );
}
1693
$uncompressed_size = 0;
1695
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1698
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1703
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1707
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1712
$uncompressed_size += $info['size'];
1714
$dirname = dirname( $info['name'] );
1716
if ( str_ends_with( $info['name'], '/' ) ) {
	// Directory.
	$needed_dirs[] = $to . untrailingslashit( $info['name'] );
} elseif ( '.' !== $dirname ) {
	// Path to a file.
	$needed_dirs[] = $to . untrailingslashit( $dirname );
}
}
1725
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1728
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1736
if ( $available_space && ( $required_space > $available_space ) ) {
	$z->close();
	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' )
	);
}
}
1746
$needed_dirs = array_unique( $needed_dirs );
1748
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).
	continue;
}
1754
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1758
$parent_folder = dirname( $dir );
1760
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1769
asort( $needed_dirs );
1771
// 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 ) ) {
	$z->close();
	return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), $_dir );
}
}
1780
/**
* Filters archive unzipping to override with a custom process.
*
* @since 6.4.0
*
* @param null|true|WP_Error $result         The result of the override. True on success, otherwise WP Error. Default null.
* @param string             $file           Full path and filename of ZIP archive.
* @param string             $to             Full path on the filesystem to extract archive to.
* @param string[]           $needed_dirs    A full list of required folders that need to be created.
* @param float              $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1793
if ( null !== $pre ) {
// Ensure the ZIP file archive has been closed.
$z->close();
1797
return $pre;
}
1800
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1803
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1808
if ( str_ends_with( $info['name'], '/' ) ) { // Directory.
	continue;
}
1812
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1816
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1821
$contents = $z->getFromIndex( $i );
1823
if ( false === $contents ) {
	$z->close();
	return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] );
}
1828
if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE ) ) {
	$z->close();
	return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] );
}
}
1834
$z->close();
1836
/**
* Filters the result of unzipping an archive.
*
* @since 6.4.0
*
* @param true|WP_Error $result         The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
* @param string        $file           Full path and filename of ZIP archive.
* @param string        $to             Full path on the filesystem the archive was extracted to.
* @param string[]      $needed_dirs    A full list of required folders that were created.
* @param float         $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1849
unset( $needed_dirs );
1851
return $result;
1853}
1854
1855/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1874function _unzip_file_pclzip( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1876
mbstring_binary_safe_encoding();
1878
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1880
$archive = new PclZip( $file );
1882
$archive_files = $archive->extract( PCLZIP_OPT_EXTRACT_AS_STRING );
1884
reset_mbstring_encoding();
1886
// Is the archive valid?
if ( ! is_array( $archive_files ) ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), $archive->errorInfo( true ) );
}
1891
if ( 0 === count( $archive_files ) ) {
return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) );
}
1895
$uncompressed_size = 0;
1897
// Determine any children directories needed (From within the archive).
foreach ( $archive_files as $archive_file ) {
if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1903
$uncompressed_size += $archive_file['size'];
1905
$needed_dirs[] = $to . untrailingslashit( $archive_file['folder'] ? $archive_file['filename'] : dirname( $archive_file['filename'] ) );
}
1908
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1911
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1919
if ( $available_space && ( $required_space > $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' )
	);
}
}
1928
$needed_dirs = array_unique( $needed_dirs );
1930
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).
	continue;
}
1936
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1940
$parent_folder = dirname( $dir );
1942
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1951
asort( $needed_dirs );
1953
// 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_pclzip', __( 'Could not create directory.' ), $_dir );
}
}
1961
/** This filter is documented in src/wp-admin/includes/file.php */
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1964
if ( null !== $pre ) {
return $pre;
}
1968
// Extract the files from the zip.
foreach ( $archive_files as $archive_file ) {
if ( $archive_file['folder'] ) {
	continue;
}

if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1978
// Don't extract invalid files:
if ( 0 !== validate_file( $archive_file['filename'] ) ) {
	continue;
}
1983
if ( ! $wp_filesystem->put_contents( $to . $archive_file['filename'], $archive_file['content'], FS_CHMOD_FILE ) ) {
	return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $archive_file['filename'] );
}
}
1988
/** This action is documented in src/wp-admin/includes/file.php */
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1991
unset( $needed_dirs );
1993
return $result;
1995}
1996
1997/**
* 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 WordPress filesystem subclass.
*
* @param string   $from      Source directory.
* @param string   $to        Destination directory.
* @param string[] $skip_list An array of files/folders to skip copying.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2012function copy_dir( $from, $to, $skip_list = array() ) {
global $wp_filesystem;
2014
$dirlist = $wp_filesystem->dirlist( $from );
2016
if ( false === $dirlist ) {
return new WP_Error( 'dirlist_failed_copy_dir', __( 'Directory listing failed.' ), basename( $from ) );
}
2020
$from = trailingslashit( $from );
$to   = trailingslashit( $to );
2023
if ( ! $wp_filesystem->exists( $to ) && ! $wp_filesystem->mkdir( $to ) ) {
return new WP_Error(
	'mkdir_destination_failed_copy_dir',
	__( 'Could not create the destination directory.' ),
	basename( $to )
);
}
2031
foreach ( (array) $dirlist as $filename => $fileinfo ) {
if ( in_array( $filename, $skip_list, true ) ) {
	continue;
}
2036
if ( 'f' === $fileinfo['type'] ) {
	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 );
2041
		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 );
		}
	}
2046
	wp_opcache_invalidate( $to . $filename );
} elseif ( 'd' === $fileinfo['type'] ) {
	if ( ! $wp_filesystem->is_dir( $to . $filename ) ) {
		if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) {
			return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename );
		}
	}
2054
	// Generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list.
	$sub_skip_list = array();
2057
	foreach ( $skip_list as $skip_item ) {
		if ( str_starts_with( $skip_item, $filename . '/' ) ) {
			$sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
		}
	}
2063
	$result = copy_dir( $from . $filename, $to . $filename, $sub_skip_list );
2065
	if ( is_wp_error( $result ) ) {
		return $result;
	}
}
}
2071
return true;
2073}
2074
2075/**
* Moves a directory from one location to another.
*
* Recursively invalidates OPcache on success.
*
* If the renaming failed, falls back to copy_dir().
*
* Assumes that WP_Filesystem() has already been called and setup.
*
* This function is not designed to merge directories, copy_dir() should be used instead.
*
* @since 6.2.0
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $from      Source directory.
* @param string $to        Destination directory.
* @param bool   $overwrite Optional. Whether to overwrite the destination directory if it exists.
*                          Default false.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2096function move_dir( $from, $to, $overwrite = false ) {
global $wp_filesystem;
2098
if ( trailingslashit( strtolower( $from ) ) === trailingslashit( strtolower( $to ) ) ) {
return new WP_Error( 'source_destination_same_move_dir', __( 'The source and destination are the same.' ) );
}
2102
if ( $wp_filesystem->exists( $to ) ) {
if ( ! $overwrite ) {
	return new WP_Error( 'destination_already_exists_move_dir', __( 'The destination folder already exists.' ), $to );
} elseif ( ! $wp_filesystem->delete( $to, true ) ) {
	// Can't overwrite if the destination couldn't be deleted.
	return new WP_Error( 'destination_not_deleted_move_dir', __( 'The destination directory already exists and could not be removed.' ) );
}
}
2111
if ( $wp_filesystem->move( $from, $to ) ) {
/*
 * When using an environment with shared folders,
 * there is a delay in updating the filesystem's cache.
 *
 * This is a known issue in environments with a VirtualBox provider.
 *
 * A 200ms delay gives time for the filesystem to update its cache,
 * prevents "Operation not permitted", and "No such file or directory" warnings.
 *
 * This delay is used in other projects, including Composer.
 * @link https://github.com/composer/composer/blob/2.5.1/src/Composer/Util/Platform.php#L228-L233
 */
usleep( 200000 );
wp_opcache_invalidate_directory( $to );
2127
return true;
}
2130
// Fall back to a recursive copy.
if ( ! $wp_filesystem->is_dir( $to ) ) {
if ( ! $wp_filesystem->mkdir( $to, FS_CHMOD_DIR ) ) {
	return new WP_Error( 'mkdir_failed_move_dir', __( 'Could not create directory.' ), $to );
}
}
2137
$result = copy_dir( $from, $to, array( basename( $to ) ) );
2139
// Clear the source directory.
if ( true === $result ) {
$wp_filesystem->delete( $from, true );
}
2144
return $result;
2146}
2147
2148/**
* Initializes 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 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 bool|null True on success, false on failure,
*                   null if the filesystem method class file does not exist.
*/
2170function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
global $wp_filesystem;
2172
require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
2174
$method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership );
2176
if ( ! $method ) {
return false;
}
2180
if ( ! class_exists( "WP_Filesystem_$method" ) ) {
2182
/**
 * Filters the path for a specific filesystem method class file.
 *
 * @since 2.6.0
 *
 * @see get_filesystem_method()
 *
 * @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 );
2194
if ( ! file_exists( $abstraction_file ) ) {
	return;
}
2198
require_once $abstraction_file;
}
$method = "WP_Filesystem_$method";
2202
$wp_filesystem = new $method( $args );
2204
/*
* Define the timeouts for the connections. Only available after the constructor is called
* to allow for per-transport overriding of the default.
*/
if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {
define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds.
}
if ( ! defined( 'FS_TIMEOUT' ) ) {
define( 'FS_TIMEOUT', 30 ); // 30 seconds.
}
2215
if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
return false;
}
2219
if ( ! $wp_filesystem->connect() ) {
return false; // There was an error connecting to the server.
}
2223
// Set the permission constants if not already set.
if ( ! defined( 'FS_CHMOD_DIR' ) ) {
define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
}
if ( ! defined( 'FS_CHMOD_FILE' ) ) {
define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
}
2231
return true;
2233}
2234
2235/**
* Determines which method to use for reading, writing, modifying, or deleting
* files on the filesystem.
*
* The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets
* (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2',
* 'ftpext' or 'ftpsockets'.
*
* The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
* or filtering via {@see 'filesystem_method'}.
*
* @link https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#wordpress-upgrade-constants
*
* Plugins may define a custom transport handler, See WP_Filesystem().
*
* @since 2.5.0
*
* @global callable $_wp_filesystem_direct_method
*
* @param array  $args                         Optional. Connection details. Default empty array.
* @param string $context                      Optional. Full path to the directory that is tested
*                                             for being writable. Default empty.
* @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.
*/
2261function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) {
// Please ensure that this is either 'direct', 'ssh2', 'ftpext', or 'ftpsockets'.
$method = defined( 'FS_METHOD' ) ? FS_METHOD : false;
2264
if ( ! $context ) {
$context = WP_CONTENT_DIR;
}
2268
// If the directory doesn't exist (wp-content/languages) then use the parent directory as we'll create it.
if ( WP_LANG_DIR === $context && ! is_dir( $context ) ) {
$context = dirname( $context );
}
2273
$context = trailingslashit( $context );
2275
if ( ! $method ) {
2277
$temp_file_name = $context . 'temp-write-test-' . str_replace( '.', '-', uniqid( '', true ) );
$temp_handle    = @fopen( $temp_file_name, 'w' );
if ( $temp_handle ) {
2281
	// Attempt to determine the file owner of the WordPress files, and that of newly created files.
	$wp_file_owner   = false;
	$temp_file_owner = false;
	if ( function_exists( 'fileowner' ) ) {
		$wp_file_owner   = @fileowner( __FILE__ );
		$temp_file_owner = @fileowner( $temp_file_name );
	}
2289
	if ( false !== $wp_file_owner && $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';
		$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';
		$GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
	}
2306
	fclose( $temp_handle );
	@unlink( $temp_file_name );
}
}
2311
if ( ! $method && isset( $args['connection_type'] ) && 'ssh' === $args['connection_type'] && extension_loaded( 'ssh2' ) ) {
$method = 'ssh2';
}
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.
}
2321
/**
* Filters the filesystem method to use.
*
* @since 2.6.0
*
* @param string $method                       Filesystem method to return.
* @param array  $args                         An array of connection details for the method.
* @param string $context                      Full path to the directory that is tested for being writable.
* @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
return apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership );
2333}
2334
2335/**
* Displays a form to the user to request for their FTP/SSH details in order
* to connect to the filesystem.
*
* All chosen/entered details are saved, excluding the password.
*
* Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
* to specify an alternate FTP/SSH port.
*
* Plugins may override this form by returning true|false via the {@see 'request_filesystem_credentials'} filter.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @global string $pagenow The filename of the current screen.
*
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Optional. Chosen type of filesystem. Default empty.
* @param bool|WP_Error $error                        Optional. Whether the current request has failed
*                                                    to connect, or an error object. Default false.
* @param string        $context                      Optional. Full path to the directory that is tested
*                                                    for being 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|array True if no filesystem credentials are required,
*                    false if they are required but have not been provided,
*                    array of credentials if they are required and have been provided.
*/
2365function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
global $pagenow;
2367
/**
* Filters the filesystem credentials.
*
* Returning anything other than an empty string will effectively short-circuit
* output of the filesystem credentials form, returning that value instead.
*
* A filter should return true if no filesystem credentials are required, false if they are required but have not been
* provided, or an array of credentials if they are required and have been provided.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param mixed         $credentials                  Credentials to return instead. Default empty string.
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Chosen type of filesystem.
* @param bool|WP_Error $error                        Whether the current request has failed to connect,
*                                                    or an error object.
* @param string        $context                      Full path to the directory that is tested for
*                                                    being writable.
* @param array         $extra_fields                 Extra POST fields.
* @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
2391
if ( '' !== $req_cred ) {
return $req_cred;
}
2395
if ( empty( $type ) ) {
$type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
}
2399
if ( 'direct' === $type ) {
return true;
}
2403
if ( is_null( $extra_fields ) ) {
$extra_fields = array( 'version', 'locale' );
}
2407
$credentials = get_option(
'ftp_credentials',
array(
	'hostname' => '',
	'username' => '',
)
);
2415
$submitted_form = wp_unslash( $_POST );
2417
// Verify nonce, or unset submitted form field values on failure.
if ( ! isset( $_POST['_fs_nonce'] ) || ! wp_verify_nonce( $_POST['_fs_nonce'], 'filesystem-credentials' ) ) {
unset(
	$submitted_form['hostname'],
	$submitted_form['username'],
	$submitted_form['password'],
	$submitted_form['public_key'],
	$submitted_form['private_key'],
	$submitted_form['connection_type']
);
}
2429
$ftp_constants = array(
'hostname'    => 'FTP_HOST',
'username'    => 'FTP_USER',
'password'    => 'FTP_PASS',
'public_key'  => 'FTP_PUBKEY',
'private_key' => 'FTP_PRIKEY',
);
2437
/*
* If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string.
* Otherwise, keep it as it previously was (saved details in option).
*/
foreach ( $ftp_constants as $key => $constant ) {
if ( defined( $constant ) ) {
	$credentials[ $key ] = constant( $constant );
} elseif ( ! empty( $submitted_form[ $key ] ) ) {
	$credentials[ $key ] = $submitted_form[ $key ];
} elseif ( ! isset( $credentials[ $key ] ) ) {
	$credentials[ $key ] = '';
}
}
2451
// Sanitize the hostname, some people might pass in odd data.
$credentials['hostname'] = preg_replace( '|\w+://|', '', $credentials['hostname'] ); // Strip any schemes off.
2454
if ( strpos( $credentials['hostname'], ':' ) ) {
list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 );
if ( ! is_numeric( $credentials['port'] ) ) {
	unset( $credentials['port'] );
}
} else {
unset( $credentials['port'] );
}
2463
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.
$credentials['connection_type'] = 'ftps';
} elseif ( ! empty( $submitted_form['connection_type'] ) ) {
$credentials['connection_type'] = $submitted_form['connection_type'];
} elseif ( ! isset( $credentials['connection_type'] ) ) { // All else fails (and it's not defaulted to something else saved), default to FTP.
$credentials['connection_type'] = 'ftp';
}
2473
if ( ! $error
&& ( ! empty( $credentials['hostname'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['password'] )
	|| 'ssh' === $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] )
)
) {
$stored_credentials = $credentials;
2480
if ( ! empty( $stored_credentials['port'] ) ) { // Save port as part of hostname to simplify above code.
	$stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
}
2484
unset(
	$stored_credentials['password'],
	$stored_credentials['port'],
	$stored_credentials['private_key'],
	$stored_credentials['public_key']
);
2491
if ( ! wp_installing() ) {
	update_option( 'ftp_credentials', $stored_credentials, false );
}
2495
return $credentials;
}
2498
$hostname        = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
$username        = isset( $credentials['username'] ) ? $credentials['username'] : '';
$public_key      = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
$private_key     = isset( $credentials['private_key'] ) ? $credentials['private_key'] : '';
$port            = isset( $credentials['port'] ) ? $credentials['port'] : '';
$connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : '';
2505
if ( $error ) {
$error_string = __( '<strong>Error:</strong> Could not connect to the server. Please verify the settings are correct.' );
if ( is_wp_error( $error ) ) {
	$error_string = esc_html( $error->get_error_message() );
}
wp_admin_notice(
	$error_string,
	array(
		'id'                 => 'message',
		'additional_classes' => array( 'error' ),
	)
);
}
2519
$types = array();
if ( extension_loaded( 'ftp' ) || extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) {
$types['ftp'] = __( 'FTP' );
}
if ( extension_loaded( 'ftp' ) ) { // Only this supports FTPS.
$types['ftps'] = __( 'FTPS (SSL)' );
}
if ( extension_loaded( 'ssh2' ) ) {
$types['ssh'] = __( 'SSH2' );
}
2530
/**
* Filters the connection types to output to the filesystem credentials form.
*
* @since 2.9.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param string[]      $types       Types of connections.
* @param array         $credentials Credentials to connect with.
* @param string        $type        Chosen filesystem method.
* @param bool|WP_Error $error       Whether the current request has failed to connect,
*                                   or an error object.
* @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 );
?>
2546<form action="<?php echo esc_url( $form_post ); ?>" method="post">
2547<div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form">
<?php
// Print a H1 heading in the FTP credentials modal dialog, default is a H2.
$heading_tag = 'h2';
if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) {
$heading_tag = 'h1';
}
echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>";
?>
2556<p id="request-filesystem-credentials-desc">
<?php
$label_user = __( 'Username' );
$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.' );
	$label_user = __( 'FTP/SSH Username' );
	$label_pass = __( 'FTP/SSH Password' );
} else {
	_e( 'Please enter your FTP credentials to proceed.' );
	$label_user = __( 'FTP Username' );
	$label_pass = __( 'FTP Password' );
}
echo ' ';
}
_e( 'If you do not remember your credentials, you should contact your web host.' );
2575
$hostname_value = esc_attr( $hostname );
if ( ! empty( $port ) ) {
$hostname_value .= ":$port";
}
2580
$password_value = '';
if ( defined( 'FTP_PASS' ) ) {
$password_value = '*****';
}
?>
2586</p>
2587<label for="hostname">
<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 $hostname_value; ?>"<?php disabled( defined( 'FTP_HOST' ) ); ?> />
2590</label>
2591<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' ) ); ?> />
</label>
2596</div>
2597<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 echo $password_value; ?>"<?php disabled( defined( 'FTP_PASS' ) ); ?> spellcheck="false" />
<?php
if ( ! defined( 'FTP_PASS' ) ) {
	_e( 'This password will not be stored on the server.' );
}
?>
</label>
2607</div>
2608<fieldset>
2609<legend><?php _e( 'Connection Type' ); ?></legend>
<?php
$disabled = disabled( ( defined( 'FTP_SSL' ) && FTP_SSL ) || ( defined( 'FTP_SSH' ) && FTP_SSH ), true, false );
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 ); ?> <?php echo $disabled; ?> />
<?php echo $text; ?>
</label>
<?php
endforeach;
?>
2621</fieldset>
<?php
if ( isset( $types['ssh'] ) ) {
$hidden_class = '';
if ( 'ssh' !== $connection_type ) {
	$hidden_class = ' class="hidden"';
}
?>
2629<fieldset id="ssh-keys"<?php echo $hidden_class; ?>>
2630<legend><?php _e( 'Authentication Keys' ); ?></legend>
2631<label for="public_key">
<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' ) ); ?> />
2634</label>
2635<label for="private_key">
<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' ) ); ?> />
2638</label>
2639<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>
2640</fieldset>
<?php
}
2643
foreach ( (array) $extra_fields as $field ) {
if ( isset( $submitted_form[ $field ] ) ) {
	echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( $submitted_form[ $field ] ) . '" />';
}
}
2649
/*
* Make sure the `submit_button()` function is available during the REST API call
* from WP_Site_Health_Auto_Updates::test_check_wp_filesystem_method().
*/
if ( ! function_exists( 'submit_button' ) ) {
require_once ABSPATH . 'wp-admin/includes/template.php';
}
?>
<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' ), 'primary', 'upgrade', false ); ?>
</p>
2663</div>
2664</form>
<?php
return false;
2667}
2668
2669/**
* Prints the filesystem credentials modal when needed.
*
* @since 4.2.0
*/
2674function wp_print_request_filesystem_credentials_modal() {
$filesystem_method = get_filesystem_method();
2676
ob_start();
$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
ob_end_clean();
2680
$request_filesystem_credentials = ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored );
if ( ! $request_filesystem_credentials ) {
return;
}
?>
<div id="request-filesystem-credentials-dialog" class="notification-dialog-wrap request-filesystem-credentials-dialog">
<div class="notification-dialog-background"></div>
<div class="notification-dialog" role="dialog" aria-labelledby="request-filesystem-credentials-title" tabindex="0">
	<div class="request-filesystem-credentials-dialog-content">
		<?php request_filesystem_credentials( site_url() ); ?>
	</div>
</div>
</div>
<?php
2695}
2696
2697/**
* Attempts to clear the opcode cache for an individual PHP file.
*
* This function can be called safely without having to check the file extension
* or availability of the OPcache extension.
*
* Whether or not invalidation is possible is cached to improve performance.
*
* @since 5.5.0
*
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @param string $filepath Path to the file, including extension, for which the opcode cache is to be cleared.
* @param bool   $force    Invalidate even if the modification time is not newer than the file in cache.
*                         Default false.
* @return bool True if opcache was invalidated for `$filepath`, or there was nothing to invalidate.
*              False if opcache invalidation is not available, or is disabled via filter.
*/
2715function wp_opcache_invalidate( $filepath, $force = false ) {
static $can_invalidate = null;
2717
/*
* Check to see if WordPress is able to run `opcache_invalidate()` or not, and cache the value.
*
* First, check to see if the function is available to call, then if the host has restricted
* the ability to run the function to avoid a PHP warning.
*
* `opcache.restrict_api` can specify the path for files allowed to call `opcache_invalidate()`.
*
* If the host has this set, check whether the path in `opcache.restrict_api` matches
* the beginning of the path of the origin file.
*
* `$_SERVER['SCRIPT_FILENAME']` approximates the origin file's path, but `realpath()`
* is necessary because `SCRIPT_FILENAME` can be a relative path when run from CLI.
*
* For more details, see:
* - https://www.php.net/manual/en/opcache.configuration.php
* - https://www.php.net/manual/en/reserved.variables.server.php
* - https://core.trac.wordpress.org/ticket/36455
*/
if ( null === $can_invalidate
&& function_exists( 'opcache_invalidate' )
&& ( ! ini_get( 'opcache.restrict_api' )
	|| stripos( realpath( $_SERVER['SCRIPT_FILENAME'] ), ini_get( 'opcache.restrict_api' ) ) === 0 )
) {
$can_invalidate = true;
}
2744
// If invalidation is not available, return early.
if ( ! $can_invalidate ) {
return false;
}
2749
// Verify that file to be invalidated has a PHP extension.
if ( '.php' !== strtolower( substr( $filepath, -4 ) ) ) {
return false;
}
2754
/**
* Filters whether to invalidate a file from the opcode cache.
*
* @since 5.5.0
*
* @param bool   $will_invalidate Whether WordPress will invalidate `$filepath`. Default true.
* @param string $filepath        The path to the PHP file to invalidate.
*/
if ( apply_filters( 'wp_opcache_invalidate_file', true, $filepath ) ) {
return opcache_invalidate( $filepath, $force );
}
2766
return false;
2768}
2769
2770/**
* Attempts to clear the opcode cache for a directory of files.
*
* @since 6.2.0
*
* @see wp_opcache_invalidate()
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $dir The path to the directory for which the opcode cache is to be cleared.
*/
2782function wp_opcache_invalidate_directory( $dir ) {
global $wp_filesystem;
2784
if ( ! is_string( $dir ) || '' === trim( $dir ) ) {
if ( WP_DEBUG ) {
	$error_message = sprintf(
		/* translators: %s: The function name. */
		__( '%s expects a non-empty string.' ),
		'<code>wp_opcache_invalidate_directory()</code>'
	);
	wp_trigger_error( '', $error_message );
}
return;
}
2796
$dirlist = $wp_filesystem->dirlist( $dir, false, true );
2798
if ( empty( $dirlist ) ) {
return;
}
2802
/*
* Recursively invalidate opcache of files in a directory.
*
* WP_Filesystem_*::dirlist() returns an array of file and directory information.
*
* This does not include a path to the file or directory.
* To invalidate files within sub-directories, recursion is needed
* to prepend an absolute path containing the sub-directory's name.
*
* @param array  $dirlist Array of file/directory information from WP_Filesystem_Base::dirlist(),
*                        with sub-directories represented as nested arrays.
* @param string $path    Absolute path to the directory.
*/
$invalidate_directory = static function ( $dirlist, $path ) use ( &$invalidate_directory ) {
$path = trailingslashit( $path );
2818
foreach ( $dirlist as $name => $details ) {
	if ( 'f' === $details['type'] ) {
		wp_opcache_invalidate( $path . $name, true );
	} elseif ( is_array( $details['files'] ) && ! empty( $details['files'] ) ) {
		$invalidate_directory( $details['files'], $path . $name );
	}
}
};
2827
$invalidate_directory( $dirlist, $dir );
2829}
2830

After1<?php
2/**
* Filesystem API: Top-level functionality
*
* Functions for reading, writing, modifying, and deleting files on the file system.
* Includes functionality for theme-specific files as well as operations for uploading,
* archiving, and rendering output when necessary.
*
* @package WordPress
* @subpackage Filesystem
* @since 2.3.0
*/
13
14/** The descriptions for theme files. */
15$wp_file_descriptions = array(
'functions.php'         => __( 'Theme Functions' ),
'header.php'            => __( 'Theme Header' ),
'footer.php'            => __( 'Theme Footer' ),
'sidebar.php'           => __( 'Sidebar' ),
'comments.php'          => __( 'Comments' ),
'searchform.php'        => __( 'Search Form' ),
'404.php'               => __( '404 Template' ),
'link.php'              => __( 'Links Template' ),
'theme.json'            => __( 'Theme Styles & Block Settings' ),
// Archives.
'index.php'             => __( 'Main Index Template' ),
'archive.php'           => __( 'Archives' ),
'author.php'            => __( 'Author Template' ),
'taxonomy.php'          => __( 'Taxonomy Template' ),
'category.php'          => __( 'Category Template' ),
'tag.php'               => __( 'Tag Template' ),
'home.php'              => __( 'Posts Page' ),
'search.php'            => __( 'Search Results' ),
'date.php'              => __( 'Date Template' ),
// 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' ),
'application.php'       => __( 'Application Attachment Template' ),
// Embeds.
'embed.php'             => __( 'Embed Template' ),
'embed-404.php'         => __( 'Embed 404 Template' ),
'embed-content.php'     => __( 'Embed Content Template' ),
'header-embed.php'      => __( 'Embed Header Template' ),
'footer-embed.php'      => __( 'Embed Footer Template' ),
// Stylesheets.
'style.css'             => __( 'Stylesheet' ),
'editor-style.css'      => __( 'Visual Editor Stylesheet' ),
'editor-style-rtl.css'  => __( 'Visual Editor RTL Stylesheet' ),
'rtl.css'               => __( 'RTL Stylesheet' ),
// Other.
'my-hacks.php'          => __( 'my-hacks.php (legacy hacks support)' ),
'.htaccess'             => __( '.htaccess (for rewrite rules )' ),
// Deprecated files.
'wp-layout.css'         => __( 'Stylesheet' ),
'wp-comments.php'       => __( 'Comments Template' ),
'wp-comments-popup.php' => __( 'Popup Comments Template' ),
'comments-popup.php'    => __( 'Popup Comments' ),
66);
67
68/**
* Gets the description for standard WordPress theme files.
*
* @since 1.5.0
*
* @global array $wp_file_descriptions Theme file descriptions.
* @global array $allowed_files        List of allowed files.
*
* @param string $file Filesystem path or filename.
* @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist.
*                Appends 'Page Template' to basename of $file if the file is a page template.
*/
80function get_file_description( $file ) {
global $wp_file_descriptions, $allowed_files;
82
$dirname   = pathinfo( $file, PATHINFO_DIRNAME );
$file_path = $allowed_files[ $file ];
85
if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) {
return $wp_file_descriptions[ basename( $file ) ];
} elseif ( file_exists( $file_path ) && is_file( $file_path ) ) {
$template_data = implode( '', file( $file_path ) );
90
if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) {
	/* translators: %s: Template name. */
	return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
}
}
96
return trim( basename( $file ) );
98}
99
100/**
* Gets the absolute filesystem path to the root of the WordPress installation.
*
* @since 1.5.0
*
* @return string Full filesystem path to the root of the WordPress installation.
*/
107function get_home_path() {
$home    = set_url_scheme( get_option( 'home' ), 'http' );
$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );
110
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 ) );
$home_path           = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
$home_path           = trailingslashit( $home_path );
} else {
$home_path = ABSPATH;
}
119
return str_replace( '\\', '/', $home_path );
121}
122
123/**
* Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
*
* The depth of the recursiveness can be controlled by the $levels param.
*
* @since 2.6.0
* @since 4.9.0 Added the `$exclusions` parameter.
* @since 6.3.0 Added the `$include_hidden` parameter.
*
* @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 string[] $exclusions     Optional. List of folders and files to skip.
* @param bool     $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
*                                 Default false.
* @return string[]|false Array of files on success, false on failure.
*/
139function list_files( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false ) {
if ( empty( $folder ) ) {
return false;
}
143
$folder = trailingslashit( $folder );
145
if ( ! $levels ) {
return false;
}
149
$files = array();
151
$dir = @opendir( $folder );
153
if ( $dir ) {
while ( ( $file = readdir( $dir ) ) !== false ) {
	// Skip current and parent folder links.
	if ( in_array( $file, array( '.', '..' ), true ) ) {
		continue;
	}
160
	// Skip hidden and excluded files.
	if ( ( ! $include_hidden && '.' === $file[0] ) || in_array( $file, $exclusions, true ) ) {
		continue;
	}
165
	if ( is_dir( $folder . $file ) ) {
		$files2 = list_files( $folder . $file, $levels - 1, array(), $include_hidden );
		if ( $files2 ) {
			$files = array_merge( $files, $files2 );
		} else {
			$files[] = $folder . $file . '/';
		}
	} else {
		$files[] = $folder . $file;
	}
}
177
closedir( $dir );
}
180
return $files;
182}
183
184/**
* Gets the list of file extensions that are editable in plugins.
*
* @since 4.9.0
*
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return string[] Array of editable file extensions.
*/
192function wp_get_plugin_file_editable_extensions( $plugin ) {
193
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
228
/**
* Filters the list of file types allowed for editing in the plugin file editor.
*
* @since 2.8.0
* @since 4.9.0 Added the `$plugin` parameter.
*
* @param string[] $default_types An array of editable plugin file extensions.
* @param string   $plugin        Path to the plugin file relative to the plugins directory.
*/
$file_types = (array) apply_filters( 'editable_extensions', $default_types, $plugin );
239
return $file_types;
241}
242
243/**
* Gets the list of file extensions that are editable for a given theme.
*
* @since 4.9.0
*
* @param WP_Theme $theme Theme object.
* @return string[] Array of editable file extensions.
*/
251function wp_get_theme_file_editable_extensions( $theme ) {
252
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
287
/**
* Filters the list of file types allowed for editing in the theme file editor.
*
* @since 4.4.0
*
* @param string[] $default_types An array of editable theme file extensions.
* @param WP_Theme $theme         The active theme object.
*/
$file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme );
297
// Ensure that default types are still there.
return array_unique( array_merge( $file_types, $default_types ) );
300}
301
302/**
* Prints file editor templates (for plugins and themes).
*
* @since 4.9.0
*/
307function wp_print_file_editor_templates() {
?>
<script type="text/html" id="tmpl-wp-file-editor-notice">
<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: 1: Line number, 2: File path. */
				__( 'Your PHP code changes were not applied due to an error on line %1$s of file %2$s. Please fix and try saving again.' ),
				'{{ data.line }}',
				'{{ data.file }}'
			);
			?>
		</p>
		<pre>{{ data.message }}</pre>
	<# } else if ( 'file_not_writable' === data.code ) { #>
		<p>
			<?php
			printf(
				/* translators: %s: Documentation URL. */
				__( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ),
				__( 'https://developer.wordpress.org/advanced-administration/server/file-permissions/' )
			);
			?>
		</p>
	<# } else { #>
		<p>{{ data.message || data.code }}</p>
335
		<# if ( 'lint_errors' === data.code ) { #>
			<p>
				<# var elementId = 'el-' + String( Math.random() ); #>
				<input id="{{ elementId }}"  type="checkbox">
				<label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label>
			</p>
		<# } #>
	<# } #>
	<# if ( data.dismissible ) { #>
		<button type="button" class="notice-dismiss"><span class="screen-reader-text">
			<?php
			/* translators: Hidden accessibility text. */
			_e( 'Dismiss' );
			?>
		</span></button>
	<# } #>
</div>
</script>
<?php
355}
356
357/**
* Attempts to edit a file for a theme or plugin.
*
* When editing a PHP file, loopback requests will be made to the admin and the homepage
* to attempt to see if there is a fatal error introduced. If so, the PHP change will be
* reverted.
*
* @since 4.9.0
*
* @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.
*
*     @type string $file       Relative path to file.
*     @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.
*/
378function wp_edit_theme_plugin_file( $args ) {
if ( empty( $args['file'] ) ) {
return new WP_Error( 'missing_file' );
}
382
if ( 0 !== validate_file( $args['file'] ) ) {
return new WP_Error( 'bad_file' );
}
386
if ( ! isset( $args['newcontent'] ) ) {
return new WP_Error( 'missing_content' );
}
390
if ( ! isset( $args['nonce'] ) ) {
return new WP_Error( 'missing_nonce' );
}
394
$file    = $args['file'];
$content = $args['newcontent'];
397
$plugin    = null;
$theme     = null;
$real_file = null;
401
if ( ! empty( $args['plugin'] ) ) {
$plugin = $args['plugin'];
404
if ( ! current_user_can( 'edit_plugins' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit plugins for this site.' ) );
}
408
if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
412
if ( ! array_key_exists( $plugin, get_plugins() ) ) {
	return new WP_Error( 'invalid_plugin' );
}
416
if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {
	return new WP_Error( 'bad_plugin_file_path', __( 'Sorry, that file cannot be edited.' ) );
}
420
$editable_extensions = wp_get_plugin_file_editable_extensions( $plugin );
422
$real_file = WP_PLUGIN_DIR . '/' . $file;
424
$is_active = in_array(
	$plugin,
	(array) get_option( 'active_plugins', array() ),
	true
);
430
} elseif ( ! empty( $args['theme'] ) ) {
$stylesheet = $args['theme'];
433
if ( 0 !== validate_file( $stylesheet ) ) {
	return new WP_Error( 'bad_theme_path' );
}
437
if ( ! current_user_can( 'edit_themes' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit templates for this site.' ) );
}
441
$theme = wp_get_theme( $stylesheet );
if ( ! $theme->exists() ) {
	return new WP_Error( 'non_existent_theme', __( 'The requested theme does not exist.' ) );
}
446
if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
450
if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) {
	return new WP_Error(
		'theme_no_stylesheet',
		__( 'The requested theme does not exist.' ) . ' ' . $theme->errors()->get_error_message()
	);
}
457
$editable_extensions = wp_get_theme_file_editable_extensions( $theme );
459
$allowed_files = array();
foreach ( $editable_extensions as $type ) {
	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 );
			$allowed_files['style.css'] = $style_files['style.css'];
			$allowed_files              = array_merge( $allowed_files, $style_files );
			break;
		default:
			$allowed_files = array_merge( $allowed_files, $theme->get_files( $type, -1 ) );
			break;
	}
}
476
// 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.' ) );
}
481
$real_file = $theme->get_stylesheet_directory() . '/' . $file;
483
$is_active = ( get_stylesheet() === $stylesheet || get_template() === $stylesheet );
485
} else {
return new WP_Error( 'missing_theme_or_plugin' );
}
489
// Ensure file is real.
if ( ! is_file( $real_file ) ) {
return new WP_Error( 'file_does_not_exist', __( 'File does not exist! Please double check the name and try again.' ) );
}
494
// Ensure file extension is allowed.
$extension = null;
if ( preg_match( '/\.([^.]+)$/', $real_file, $matches ) ) {
$extension = strtolower( $matches[1] );
if ( ! in_array( $extension, $editable_extensions, true ) ) {
	return new WP_Error( 'illegal_file_type', __( 'Files of this type are not editable.' ) );
}
}
503
$previous_content = file_get_contents( $real_file );
505
if ( ! is_writable( $real_file ) ) {
return new WP_Error( 'file_not_writable' );
}
509
$f = fopen( $real_file, 'w+' );
511
if ( false === $f ) {
return new WP_Error( 'file_not_writable' );
}
515
$written = fwrite( $f, $content );
fclose( $f );
518
if ( false === $written ) {
return new WP_Error( 'unable_to_write', __( 'Unable to write to file.' ) );
}
522
wp_opcache_invalidate( $real_file, true );
524
if ( $is_active && 'php' === $extension ) {
526
$scrape_key   = md5( rand() );
$transient    = 'scrape_key_' . $scrape_key;
$scrape_nonce = (string) rand();
// It shouldn't take more than 60 seconds to make the two loopback requests.
set_transient( $transient, $scrape_nonce, 60 );
532
$cookies       = wp_unslash( $_COOKIE );
$scrape_params = array(
	'wp_scrape_key'   => $scrape_key,
	'wp_scrape_nonce' => $scrape_nonce,
);
$headers       = array(
	'Cache-Control' => 'no-cache',
);
541
/** This filter is documented in wp-includes/class-wp-http-streams.php */
$sslverify = apply_filters( 'https_local_ssl_verify', false );
544
// Include Basic auth in loopback requests.
if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
	$headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );
}
549
// Make sure PHP process doesn't die before loopback requests complete.
if ( function_exists( 'set_time_limit' ) ) {
	set_time_limit( 5 * MINUTE_IN_SECONDS );
}
554
// Time to wait for loopback requests to finish.
$timeout = 100; // 100 seconds.
557
$needle_start = "###### wp_scraping_result_start:$scrape_key ######";
$needle_end   = "###### wp_scraping_result_end:$scrape_key ######";
560
// 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,
		),
		admin_url( 'theme-editor.php' )
	);
} else {
	$url = admin_url();
}
575
if ( function_exists( 'session_status' ) && PHP_SESSION_ACTIVE === session_status() ) {
	/*
	 * Close any active session to prevent HTTP requests from timing out
	 * when attempting to connect back to the site.
	 */
	session_write_close();
}
583
$url                    = add_query_arg( $scrape_params, $url );
$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
$body                   = wp_remote_retrieve_body( $r );
$scrape_result_position = strpos( $body, $needle_start );
588
$loopback_request_failure = array(
	'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(
	'code' => 'json_parse_error',
);
596
$result = null;
598
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 );
	if ( empty( $result ) ) {
		$result = $json_parse_failure;
	}
}
609
// Try making request to homepage as well to see if visitors have been whitescreened.
if ( true === $result ) {
	$url                    = home_url( '/' );
	$url                    = add_query_arg( $scrape_params, $url );
	$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
	$body                   = wp_remote_retrieve_body( $r );
	$scrape_result_position = strpos( $body, $needle_start );
617
	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 );
		if ( empty( $result ) ) {
			$result = $json_parse_failure;
		}
	}
}
629
delete_transient( $transient );
631
if ( true !== $result ) {
	// Roll-back file change.
	file_put_contents( $real_file, $previous_content );
	wp_opcache_invalidate( $real_file, true );
636
	if ( ! isset( $result['message'] ) ) {
		$message = __( 'An error occurred. Please try again later.' );
	} else {
		$message = $result['message'];
		unset( $result['message'] );
	}
643
	return new WP_Error( 'php_error', $message, $result );
}
}
647
if ( $theme instanceof WP_Theme ) {
$theme->cache_delete();
}
651
return true;
653}
654
655
656/**
* Returns a filename of a temporary unique file.
*
* Please note that the calling function must delete or move the file.
*
* The filename is based off the passed parameter or defaults to the current unix timestamp,
* while the directory can either be passed as well, or by leaving it blank, default to a writable
* temporary directory.
*
* @since 2.6.0
*
* @param string $filename Optional. Filename to base the Unique file off. Default empty.
* @param string $dir      Optional. Directory to store the file in. Default empty.
* @return string A writable filename.
*/
671function wp_tempnam( $filename = '', $dir = '' ) {
if ( empty( $dir ) ) {
$dir = get_temp_dir();
}
675
if ( empty( $filename ) || in_array( $filename, array( '.', '/', '\\' ), true ) ) {
$filename = uniqid();
}
679
// 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 );
683
// If the folder is falsey, use its parent directory name instead.
if ( ! $temp_filename ) {
return wp_tempnam( dirname( $filename ), $dir );
}
688
// Suffix some random data to avoid filename conflicts.
$temp_filename .= '-' . wp_generate_password( 6, false );
$temp_filename .= '.tmp';
$temp_filename  = wp_unique_filename( $dir, $temp_filename );
693
/*
* Filesystems typically have a limit of 255 characters for a filename.
*
* If the generated unique filename exceeds this, truncate the initial
* filename and try again.
*
* As it's possible that the truncated filename may exist, producing a
* suffix of "-1" or "-10" which could exceed the limit again, truncate
* it to 252 instead.
*/
$characters_over_limit = strlen( $temp_filename ) - 252;
if ( $characters_over_limit > 0 ) {
$filename = substr( $filename, 0, -$characters_over_limit );
return wp_tempnam( $filename, $dir );
}
709
$temp_filename = $dir . $temp_filename;
711
$fp = @fopen( $temp_filename, 'x' );
713
if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) {
return wp_tempnam( $filename, $dir );
}
717
if ( $fp ) {
fclose( $fp );
}
721
return $temp_filename;
723}
724
725/**
* Makes sure that the file that was requested to be edited is allowed to be edited.
*
* 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[] $allowed_files Optional. Array of allowed files to edit.
*                                `$file` must match an entry exactly.
* @return string|void Returns the file name on success, dies on failure.
*/
737function validate_file_to_edit( $file, $allowed_files = array() ) {
$code = validate_file( $file, $allowed_files );
739
if ( ! $code ) {
return $file;
}
743
switch ( $code ) {
case 1:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
747
	// case 2 :
	// wp_die( __('Sorry, cannot call files with their real path.' ));
750
case 3:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
}
754}
755
756/**
* Handles PHP uploads in WordPress.
*
* Sanitizes file names, checks extensions for mime type, and moves the file
* to the appropriate directory within the uploads directory.
*
* @access private
* @since 4.0.0
*
* @see wp_handle_upload_error
*
* @param array       $file      {
*     Reference to a single element from `$_FILES`. Call the function once for each uploaded file.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param array|false $overrides {
*     An array of override parameters for this file, or boolean false if none are provided.
*
*     @type callable $upload_error_handler     Function to call when there is an error during the upload process.
*                                              See {@see wp_handle_upload_error()}.
*     @type callable $unique_filename_callback Function to call when determining a unique file name for the file.
*                                              See {@see wp_unique_filename()}.
*     @type string[] $upload_error_strings     The strings that describe the error indicated in
*                                              `$_FILES[{form field}]['error']`.
*     @type bool     $test_form                Whether to test that the `$_POST['action']` parameter is as expected.
*     @type bool     $test_size                Whether to test that the file size is greater than zero bytes.
*     @type bool     $test_type                Whether to test that the mime type of the file is as expected.
*     @type string[] $mimes                    Array of allowed mime types keyed by their file extension regex.
* }
* @param string      $time      Time formatted in 'yyyy/mm'.
* @param string      $action    Expected value for `$_POST['action']`.
* @return array {
*     On success, returns an associative array of file attributes.
*     On failure, returns `$overrides['upload_error_handler']( &$file, $message )`
*     or `array( 'error' => $message )`.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
*/
802function _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 ) {
	return array( 'error' => $message );
}
}
809
/**
* Filters the data for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_prefilter`
*  - `wp_handle_upload_prefilter`
*
* @since 2.9.0 as 'wp_handle_upload_prefilter'.
* @since 4.0.0 Converted to a dynamic hook with `$action`.
*
* @param array $file {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$file = apply_filters( "{$action}_prefilter", $file );
834
/**
* Filters the override parameters for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_overrides`
*  - `wp_handle_upload_overrides`
*
* @since 5.7.0
*
* @param array|false $overrides An array of override parameters for this file. Boolean false if none are
*                               provided. See {@see _wp_handle_upload()}.
* @param array       $file      {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$overrides = apply_filters( "{$action}_overrides", $overrides, $file );
860
// You may define your own function and pass the name in $overrides['upload_error_handler'].
$upload_error_handler = 'wp_handle_upload_error';
if ( isset( $overrides['upload_error_handler'] ) ) {
$upload_error_handler = $overrides['upload_error_handler'];
}
866
// You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully.
if ( isset( $file['error'] ) && ! is_numeric( $file['error'] ) && $file['error'] ) {
return call_user_func_array( $upload_error_handler, array( &$file, $file['error'] ) );
}
871
// Install user overrides. Did we mention that this voids your warranty?
873
// You may define your own function and pass the name in $overrides['unique_filename_callback'].
$unique_filename_callback = null;
if ( isset( $overrides['unique_filename_callback'] ) ) {
$unique_filename_callback = $overrides['unique_filename_callback'];
}
879
/*
* This may not have originally been intended to be overridable,
* but historically has been.
*/
if ( isset( $overrides['upload_error_strings'] ) ) {
$upload_error_strings = $overrides['upload_error_strings'];
} else {
// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
$upload_error_strings = array(
	false,
	sprintf(
		/* translators: 1: upload_max_filesize, 2: php.ini */
		__( 'The uploaded file exceeds the %1$s directive in %2$s.' ),
		'upload_max_filesize',
		'php.ini'
	),
	sprintf(
		/* translators: %s: MAX_FILE_SIZE */
		__( 'The uploaded file exceeds the %s directive that was specified in the HTML form.' ),
		'MAX_FILE_SIZE'
	),
	__( '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.' ),
);
}
909
// 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;
913
// 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'] : null;
917
// 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.' ) ) );
}
922
// 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'] ] ) );
}
927
// 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.' ) ) );
}
933
$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 ) ) {
if ( is_multisite() ) {
	$error_msg = __( 'File is empty. Please upload something more substantial.' );
} else {
	$error_msg = sprintf(
		/* translators: 1: php.ini, 2: post_max_size, 3: upload_max_filesize */
		__( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your %1$s file or by %2$s being defined as smaller than %3$s in %1$s.' ),
		'php.ini',
		'post_max_size',
		'upload_max_filesize'
	);
}
948
return call_user_func_array( $upload_error_handler, array( &$file, $error_msg ) );
}
951
// 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 );
$ext             = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext'];
$type            = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type'];
$proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename'];
958
// Check to see if wp_check_filetype_and_ext() determined the filename was incorrect.
if ( $proper_filename ) {
	$file['name'] = $proper_filename;
}
963
if ( ( ! $type || ! $ext ) && ! current_user_can( 'unfiltered_upload' ) ) {
	return call_user_func_array( $upload_error_handler, array( &$file, __( 'Sorry, you are not allowed to upload this file type.' ) ) );
}
967
if ( ! $type ) {
	$type = $file['type'];
}
} else {
$type = '';
}
974
/*
* A writable uploads dir will pass this test. Again, there's no point
* overriding this one.
*/
$uploads = wp_upload_dir( $time );
if ( ! ( $uploads && false === $uploads['error'] ) ) {
return call_user_func_array( $upload_error_handler, array( &$file, $uploads['error'] ) );
}
983
$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
985
// Move the file to the uploads dir.
$new_file = $uploads['path'] . "/$filename";
988
/**
* Filters whether to short-circuit moving the uploaded file after passing all checks.
*
* If a non-null value is returned from the filter, moving the file and any related
* error reporting will be completely skipped.
*
* @since 4.9.0
*
* @param mixed    $move_new_file If null (default) move the file after the upload.
* @param array    $file          {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param string   $new_file      Filename of the newly-uploaded file.
* @param string   $type          Mime type of the newly-uploaded file.
*/
$move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type );
1011
if ( null === $move_new_file ) {
if ( 'wp_handle_upload' === $action ) {
	$move_new_file = @move_uploaded_file( $file['tmp_name'], $new_file );
} else {
	// Use copy and unlink because rename breaks streams.
	// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
	$move_new_file = @copy( $file['tmp_name'], $new_file );
	unlink( $file['tmp_name'] );
}
1021
if ( false === $move_new_file ) {
	if ( str_starts_with( $uploads['basedir'], ABSPATH ) ) {
		$error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
	} else {
		$error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
	}
1028
	return $upload_error_handler(
		$file,
		sprintf(
			/* translators: %s: Destination file path. */
			__( 'The uploaded file could not be moved to %s.' ),
			$error_path
		)
	);
}
}
1039
// Set correct file permissions.
$stat  = stat( dirname( $new_file ) );
$perms = $stat['mode'] & 0000666;
chmod( $new_file, $perms );
1044
// Compute the URL.
$url = $uploads['url'] . "/$filename";
1047
if ( is_multisite() ) {
clean_dirsize_cache( $new_file );
}
1051
/**
* Filters the data array for the uploaded file.
*
* @since 2.1.0
*
* @param array  $upload {
*     Array of upload data.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
* @param string $context The type of upload action. Values include 'upload' or 'sideload'.
*/
return apply_filters(
'wp_handle_upload',
array(
	'file' => $new_file,
	'url'  => $url,
	'type' => $type,
),
'wp_handle_sideload' === $action ? 'sideload' : 'upload'
);
1075}
1076
1077/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_upload'} action.
*
* @since 2.0.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1095function wp_handle_upload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_upload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1104
return _wp_handle_upload( $file, $overrides, $time, $action );
1106}
1107
1108/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_sideload'} action.
*
* @since 2.6.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1126function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_sideload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1135
return _wp_handle_upload( $file, $overrides, $time, $action );
1137}
1138
1139/**
* Downloads a URL to a local temporary file using the WordPress HTTP API.
*
* Please note that the calling function must delete or move the file.
*
* @since 2.5.0
* @since 5.2.0 Signature Verification with SoftFail was added.
* @since 5.9.0 Support for Content-Disposition filename 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 bool   $signature_verification Whether to perform Signature Verification.
*                                       Default false.
* @return string|WP_Error Filename on success, WP_Error on failure.
*/
1155function download_url( $url, $timeout = 300, $signature_verification = false ) {
// WARNING: The file is not automatically deleted, the script must delete or move the file.
if ( ! $url ) {
return new WP_Error( 'http_no_url', __( 'No URL Provided.' ) );
}
1160
$url_path     = parse_url( $url, PHP_URL_PATH );
$url_filename = '';
if ( is_string( $url_path ) && '' !== $url_path ) {
$url_filename = basename( $url_path );
}
1166
$tmpfname = wp_tempnam( $url_filename );
if ( ! $tmpfname ) {
return new WP_Error( 'http_no_file', __( 'Could not create temporary file.' ) );
}
1171
$response = wp_safe_remote_get(
$url,
array(
	'timeout'  => $timeout,
	'stream'   => true,
	'filename' => $tmpfname,
)
);
1180
if ( is_wp_error( $response ) ) {
unlink( $tmpfname );
return $response;
}
1185
$response_code = wp_remote_retrieve_response_code( $response );
1187
if ( 200 !== $response_code ) {
$data = array(
	'code' => $response_code,
);
1192
// Retrieve a sample of the response body for debugging purposes.
$tmpf = fopen( $tmpfname, 'rb' );
1195
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 );
1207
	$data['body'] = fread( $tmpf, $response_size );
	fclose( $tmpf );
}
1211
unlink( $tmpfname );
1213
return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data );
}
1216
$content_disposition = wp_remote_retrieve_header( $response, 'Content-Disposition' );
1218
if ( $content_disposition ) {
$content_disposition = strtolower( $content_disposition );
1221
if ( str_starts_with( $content_disposition, 'attachment; filename=' ) ) {
	$tmpfname_disposition = sanitize_file_name( substr( $content_disposition, 21 ) );
} else {
	$tmpfname_disposition = '';
}
1227
// Potential file name must be valid string.
if ( $tmpfname_disposition && is_string( $tmpfname_disposition )
	&& ( 0 === validate_file( $tmpfname_disposition ) )
) {
	$tmpfname_disposition = dirname( $tmpfname ) . '/' . $tmpfname_disposition;
1233
	if ( rename( $tmpfname, $tmpfname_disposition ) ) {
		$tmpfname = $tmpfname_disposition;
	}
1237
	if ( ( $tmpfname !== $tmpfname_disposition ) && file_exists( $tmpfname_disposition ) ) {
		unlink( $tmpfname_disposition );
	}
}
}
1243
$mime_type = wp_remote_retrieve_header( $response, 'content-type' );
if ( $mime_type && 'tmp' === pathinfo( $tmpfname, PATHINFO_EXTENSION ) ) {
$valid_mime_types = array_flip( get_allowed_mime_types() );
if ( ! empty( $valid_mime_types[ $mime_type ] ) ) {
	$extensions     = explode( '|', $valid_mime_types[ $mime_type ] );
	$new_image_name = substr( $tmpfname, 0, -4 ) . ".{$extensions[0]}";
	if ( 0 === validate_file( $new_image_name ) ) {
		if ( rename( $tmpfname, $new_image_name ) ) {
			$tmpfname = $new_image_name;
		}
1254
		if ( ( $tmpfname !== $new_image_name ) && file_exists( $new_image_name ) ) {
			unlink( $new_image_name );
		}
	}
}
}
1261
$content_md5 = wp_remote_retrieve_header( $response, 'Content-MD5' );
1263
if ( $content_md5 ) {
$md5_check = verify_file_md5( $tmpfname, $content_md5 );
1266
if ( is_wp_error( $md5_check ) ) {
	unlink( $tmpfname );
	return $md5_check;
}
}
1272
// 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 attempted on.
 *
 * @since 5.2.0
 *
 * @param string[] $hostnames List of hostnames.
 */
$signed_hostnames = apply_filters( 'wp_signature_hosts', array( 'wordpress.org', 'downloads.wordpress.org', 's.w.org' ) );
1283
$signature_verification = in_array( parse_url( $url, PHP_URL_HOST ), $signed_hostnames, true );
}
1286
// Perform signature validation if supported.
if ( $signature_verification ) {
$signature = wp_remote_retrieve_header( $response, 'X-Content-Signature' );
1290
if ( ! $signature ) {
	/*
	 * Retrieve signatures from a file if the header wasn't included.
	 * WordPress.org stores signatures at $package_url.sig.
	 */
1296
	$signature_url = false;
1298
	if ( is_string( $url_path ) && ( str_ends_with( $url_path, '.zip' ) || str_ends_with( $url_path, '.tar.gz' ) ) ) {
		$signature_url = str_replace( $url_path, $url_path . '.sig', $url );
	}
1302
	/**
	 * Filters 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 );
1312
	if ( $signature_url ) {
		$signature_request = wp_safe_remote_get(
			$signature_url,
			array(
				'limit_response_size' => 10 * KB_IN_BYTES, // 10KB should be large enough for quite a few signatures.
			)
		);
1320
		if ( ! is_wp_error( $signature_request ) && 200 === wp_remote_retrieve_response_code( $signature_request ) ) {
			$signature = explode( "\n", wp_remote_retrieve_body( $signature_request ) );
		}
	}
}
1326
// Perform the checks.
$signature_verification = verify_file_signature( $tmpfname, $signature, $url_filename );
}
1330
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 );
}
1350
return $signature_verification;
}
1353
return $tmpfname;
1355}
1356
1357/**
* 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 $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5,
*                             or a hex-encoded md5.
* @return bool|WP_Error True on success, false when the MD5 format is unknown/unexpected,
*                       WP_Error on failure.
*/
1368function verify_file_md5( $filename, $expected_md5 ) {
if ( 32 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = pack( 'H*', $expected_md5 );
} elseif ( 24 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = base64_decode( $expected_md5 );
} else {
return false; // Unknown format.
}
1376
$file_md5 = md5_file( $filename, true );
1378
if ( $file_md5 === $expected_raw_md5 ) {
return true;
}
1382
return new WP_Error(
'md5_mismatch',
sprintf(
	/* translators: 1: File checksum, 2: Expected checksum value. */
	__( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ),
	bin2hex( $file_md5 ),
	bin2hex( $expected_raw_md5 )
)
);
1392}
1393
1394/**
* Verifies the contents of a file against its ED25519 signature.
*
* @since 5.2.0
*
* @param string       $filename            The file to validate.
* @param string|array $signatures          A Signature provided for the file.
* @param string|false $filename_for_errors Optional. A friendly filename for errors.
* @return bool|WP_Error True on success, false if verification not attempted,
*                       or WP_Error describing an error condition.
*/
1405function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {
if ( ! $filename_for_errors ) {
$filename_for_errors = wp_basename( $filename );
}
1409
// Check we can process signatures.
if ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) || ! in_array( 'sha384', array_map( 'strtolower', hash_algos() ), true ) ) {
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' )
);
}
1422
// Verify runtime speed of Sodium_Compat is acceptable.
if ( ! extension_loaded( 'sodium' ) && ! ParagonIE_Sodium_Compat::polyfill_is_fast() ) {
$sodium_compat_is_fast = false;
1426
// 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 utilizes during signing verifications.
	 */
	// phpcs:disable WordPress.NamingConventions.ValidVariableName
	$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;
	// phpcs:enable
}
1440
/*
 * 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'                => PHP_VERSION,
			'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' ),
		)
	);
}
}
1462
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,
	)
);
}
1476
$trusted_keys = wp_trusted_keys();
$file_hash    = hash_file( 'sha384', $filename, true );
1479
mbstring_binary_safe_encoding();
1481
$skipped_key       = 0;
$skipped_signature = 0;
1484
foreach ( (array) $signatures as $signature ) {
$signature_raw = base64_decode( $signature );
1487
// Ensure only valid-length signatures are considered.
if ( SODIUM_CRYPTO_SIGN_BYTES !== strlen( $signature_raw ) ) {
	++$skipped_signature;
	continue;
}
1493
foreach ( (array) $trusted_keys as $key ) {
	$key_raw = base64_decode( $key );
1496
	// Only pass valid public keys through.
	if ( SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES !== strlen( $key_raw ) ) {
		++$skipped_key;
		continue;
	}
1502
	if ( sodium_crypto_sign_verify_detached( $signature_raw, $file_hash, $key_raw ) ) {
		reset_mbstring_encoding();
		return true;
	}
}
}
1509
reset_mbstring_encoding();
1511
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'         => PHP_VERSION,
	'sodium'      => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ),
)
);
1531}
1532
1533/**
* Retrieves the list of signing keys trusted by WordPress.
*
* @since 5.2.0
*
* @return string[] Array of base64-encoded signing keys.
*/
1540function wp_trusted_keys() {
$trusted_keys = array();
1542
if ( time() < 1617235200 ) {
// WordPress.org Key #1 - This key is only valid before April 1st, 2021.
$trusted_keys[] = 'fRPyrxb/MvVLbdsYi+OOEv4xc+Eqpsj+kkAS6gNOkI0=';
}
1547
// TODO: Add key #2 with longer expiration.
1549
/**
* Filters the valid signing keys used to verify the contents of files.
*
* @since 5.2.0
*
* @param string[] $trusted_keys The trusted keys that may sign packages.
*/
return apply_filters( 'wp_trusted_keys', $trusted_keys );
1558}
1559
1560/**
* Determines whether the given file is a valid ZIP file.
*
* This function does not test to ensure that a file exists. Non-existent files
* are not valid ZIPs, so those will also return false.
*
* @since 6.4.4
*
* @param string $file Full path to the ZIP file.
* @return bool Whether the file is a valid ZIP file.
*/
1571function wp_zip_file_is_valid( $file ) {
/** This filter is documented in wp-admin/includes/file.php */
if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
$archive          = new ZipArchive();
$archive_is_valid = $archive->open( $file, ZipArchive::CHECKCONS );
if ( true === $archive_is_valid ) {
	$archive->close();
	return true;
}
}
1581
// Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1584
$archive          = new PclZip( $file );
$archive_is_valid = is_array( $archive->properties() );
1587
return $archive_is_valid;
1589}
1590
1591/**
* 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 WordPress filesystem subclass.
*
* @param string $file Full path and filename of ZIP archive.
* @param string $to   Full path on the filesystem to extract archive to.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1609function unzip_file( $file, $to ) {
global $wp_filesystem;
1611
if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) {
return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
}
1615
// Unzip can use a lot of memory, but not this much hopefully.
wp_raise_memory_limit( 'admin' );
1618
$needed_dirs = array();
$to          = trailingslashit( $to );
1621
// Determine any parent directories needed (of the upgrade directory).
if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parents if no children exist.
$path = preg_split( '![/\\\]!', untrailingslashit( $to ) );
for ( $i = count( $path ); $i >= 0; $i-- ) {
	if ( empty( $path[ $i ] ) ) {
		continue;
	}
1629
	$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;
	}
1634
	if ( ! $wp_filesystem->is_dir( $dir ) ) {
		$needed_dirs[] = $dir;
	} else {
		break; // A folder exists, therefore we don't need to check the levels below this.
	}
}
}
1642
/**
* 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 );
if ( true === $result ) {
	return $result;
} elseif ( is_wp_error( $result ) ) {
	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 );
1662}
1663
1664/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1683function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1685
$z = new ZipArchive();
1687
$zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS );
1689
if ( true !== $zopen ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) );
}
1693
$uncompressed_size = 0;
1695
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1698
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1703
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1707
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1712
$uncompressed_size += $info['size'];
1714
$dirname = dirname( $info['name'] );
1716
if ( str_ends_with( $info['name'], '/' ) ) {
	// Directory.
	$needed_dirs[] = $to . untrailingslashit( $info['name'] );
} elseif ( '.' !== $dirname ) {
	// Path to a file.
	$needed_dirs[] = $to . untrailingslashit( $dirname );
}
}
1725
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1728
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1736
if ( $available_space && ( $required_space > $available_space ) ) {
	$z->close();
	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' )
	);
}
}
1746
$needed_dirs = array_unique( $needed_dirs );
1748
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).
	continue;
}
1754
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1758
$parent_folder = dirname( $dir );
1760
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1769
asort( $needed_dirs );
1771
// 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 ) ) {
	$z->close();
	return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), $_dir );
}
}
1780
/**
* Filters archive unzipping to override with a custom process.
*
* @since 6.4.0
*
* @param null|true|WP_Error $result         The result of the override. True on success, otherwise WP Error. Default null.
* @param string             $file           Full path and filename of ZIP archive.
* @param string             $to             Full path on the filesystem to extract archive to.
* @param string[]           $needed_dirs    A full list of required folders that need to be created.
* @param float              $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1793
if ( null !== $pre ) {
// Ensure the ZIP file archive has been closed.
$z->close();
1797
return $pre;
}
1800
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1803
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1808
if ( str_ends_with( $info['name'], '/' ) ) { // Directory.
	continue;
}
1812
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1816
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1821
$contents = $z->getFromIndex( $i );
1823
if ( false === $contents ) {
	$z->close();
	return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] );
}
1828
if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE ) ) {
	$z->close();
	return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] );
}
}
1834
$z->close();
1836
/**
* Filters the result of unzipping an archive.
*
* @since 6.4.0
*
* @param true|WP_Error $result         The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
* @param string        $file           Full path and filename of ZIP archive.
* @param string        $to             Full path on the filesystem the archive was extracted to.
* @param string[]      $needed_dirs    A full list of required folders that were created.
* @param float         $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1849
unset( $needed_dirs );
1851
return $result;
1853}
1854
1855/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1874function _unzip_file_pclzip( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1876
mbstring_binary_safe_encoding();
1878
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1880
$archive = new PclZip( $file );
1882
$archive_files = $archive->extract( PCLZIP_OPT_EXTRACT_AS_STRING );
1884
reset_mbstring_encoding();
1886
// Is the archive valid?
if ( ! is_array( $archive_files ) ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), $archive->errorInfo( true ) );
}
1891
if ( 0 === count( $archive_files ) ) {
return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) );
}
1895
$uncompressed_size = 0;
1897
// Determine any children directories needed (From within the archive).
foreach ( $archive_files as $archive_file ) {
if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1903
$uncompressed_size += $archive_file['size'];
1905
$needed_dirs[] = $to . untrailingslashit( $archive_file['folder'] ? $archive_file['filename'] : dirname( $archive_file['filename'] ) );
}
1908
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1911
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1919
if ( $available_space && ( $required_space > $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' )
	);
}
}
1928
$needed_dirs = array_unique( $needed_dirs );
1930
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).
	continue;
}
1936
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1940
$parent_folder = dirname( $dir );
1942
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1951
asort( $needed_dirs );
1953
// 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_pclzip', __( 'Could not create directory.' ), $_dir );
}
}
1961
/** This filter is documented in src/wp-admin/includes/file.php */
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1964
if ( null !== $pre ) {
return $pre;
}
1968
// Extract the files from the zip.
foreach ( $archive_files as $archive_file ) {
if ( $archive_file['folder'] ) {
	continue;
}
1974
if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1978
// Don't extract invalid files:
if ( 0 !== validate_file( $archive_file['filename'] ) ) {
	continue;
}
1983
if ( ! $wp_filesystem->put_contents( $to . $archive_file['filename'], $archive_file['content'], FS_CHMOD_FILE ) ) {
	return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $archive_file['filename'] );
}
}
1988
/** This action is documented in src/wp-admin/includes/file.php */
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1991
unset( $needed_dirs );
1993
return $result;
1995}
1996
1997/**
* 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 WordPress filesystem subclass.
*
* @param string   $from      Source directory.
* @param string   $to        Destination directory.
* @param string[] $skip_list An array of files/folders to skip copying.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2012function copy_dir( $from, $to, $skip_list = array() ) {
global $wp_filesystem;
2014
$dirlist = $wp_filesystem->dirlist( $from );
2016
if ( false === $dirlist ) {
return new WP_Error( 'dirlist_failed_copy_dir', __( 'Directory listing failed.' ), basename( $from ) );
}
2020
$from = trailingslashit( $from );
$to   = trailingslashit( $to );
2023
if ( ! $wp_filesystem->exists( $to ) && ! $wp_filesystem->mkdir( $to ) ) {
return new WP_Error(
	'mkdir_destination_failed_copy_dir',
	__( 'Could not create the destination directory.' ),
	basename( $to )
);
}
2031
foreach ( (array) $dirlist as $filename => $fileinfo ) {
if ( in_array( $filename, $skip_list, true ) ) {
	continue;
}
2036
if ( 'f' === $fileinfo['type'] ) {
	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 );
2041
		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 );
		}
	}
2046
	wp_opcache_invalidate( $to . $filename );
} elseif ( 'd' === $fileinfo['type'] ) {
	if ( ! $wp_filesystem->is_dir( $to . $filename ) ) {
		if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) {
			return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename );
		}
	}
2054
	// Generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list.
	$sub_skip_list = array();
2057
	foreach ( $skip_list as $skip_item ) {
		if ( str_starts_with( $skip_item, $filename . '/' ) ) {
			$sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
		}
	}
2063
	$result = copy_dir( $from . $filename, $to . $filename, $sub_skip_list );
2065
	if ( is_wp_error( $result ) ) {
		return $result;
	}
}
}
2071
return true;
2073}
2074
2075/**
* Moves a directory from one location to another.
*
* Recursively invalidates OPcache on success.
*
* If the renaming failed, falls back to copy_dir().
*
* Assumes that WP_Filesystem() has already been called and setup.
*
* This function is not designed to merge directories, copy_dir() should be used instead.
*
* @since 6.2.0
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $from      Source directory.
* @param string $to        Destination directory.
* @param bool   $overwrite Optional. Whether to overwrite the destination directory if it exists.
*                          Default false.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2096function move_dir( $from, $to, $overwrite = false ) {
global $wp_filesystem;
2098
if ( trailingslashit( strtolower( $from ) ) === trailingslashit( strtolower( $to ) ) ) {
return new WP_Error( 'source_destination_same_move_dir', __( 'The source and destination are the same.' ) );
}
2102
if ( $wp_filesystem->exists( $to ) ) {
if ( ! $overwrite ) {
	return new WP_Error( 'destination_already_exists_move_dir', __( 'The destination folder already exists.' ), $to );
} elseif ( ! $wp_filesystem->delete( $to, true ) ) {
	// Can't overwrite if the destination couldn't be deleted.
	return new WP_Error( 'destination_not_deleted_move_dir', __( 'The destination directory already exists and could not be removed.' ) );
}
}
2111
if ( $wp_filesystem->move( $from, $to ) ) {
/*
 * When using an environment with shared folders,
 * there is a delay in updating the filesystem's cache.
 *
 * This is a known issue in environments with a VirtualBox provider.
 *
 * A 200ms delay gives time for the filesystem to update its cache,
 * prevents "Operation not permitted", and "No such file or directory" warnings.
 *
 * This delay is used in other projects, including Composer.
 * @link https://github.com/composer/composer/blob/2.5.1/src/Composer/Util/Platform.php#L228-L233
 */
usleep( 200000 );
wp_opcache_invalidate_directory( $to );
2127
return true;
}
2130
// Fall back to a recursive copy.
if ( ! $wp_filesystem->is_dir( $to ) ) {
if ( ! $wp_filesystem->mkdir( $to, FS_CHMOD_DIR ) ) {
	return new WP_Error( 'mkdir_failed_move_dir', __( 'Could not create directory.' ), $to );
}
}
2137
$result = copy_dir( $from, $to, array( basename( $to ) ) );
2139
// Clear the source directory.
if ( true === $result ) {
$wp_filesystem->delete( $from, true );
}
2144
return $result;
2146}
2147
2148/**
* Initializes 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 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 bool|null True on success, false on failure,
*                   null if the filesystem method class file does not exist.
*/
2170function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
global $wp_filesystem;
2172
require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
2174
$method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership );
2176
if ( ! $method ) {
return false;
}
2180
if ( ! class_exists( "WP_Filesystem_$method" ) ) {
2182
/**
 * Filters the path for a specific filesystem method class file.
 *
 * @since 2.6.0
 *
 * @see get_filesystem_method()
 *
 * @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 );
2194
if ( ! file_exists( $abstraction_file ) ) {
	return;
}
2198
require_once $abstraction_file;
}
$method = "WP_Filesystem_$method";
2202
$wp_filesystem = new $method( $args );
2204
/*
* Define the timeouts for the connections. Only available after the constructor is called
* to allow for per-transport overriding of the default.
*/
if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {
define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds.
}
if ( ! defined( 'FS_TIMEOUT' ) ) {
define( 'FS_TIMEOUT', 30 ); // 30 seconds.
}
2215
if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
return false;
}
2219
if ( ! $wp_filesystem->connect() ) {
return false; // There was an error connecting to the server.
}
2223
// Set the permission constants if not already set.
if ( ! defined( 'FS_CHMOD_DIR' ) ) {
define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
}
if ( ! defined( 'FS_CHMOD_FILE' ) ) {
define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
}
2231
return true;
2233}
2234
2235/**
* Determines which method to use for reading, writing, modifying, or deleting
* files on the filesystem.
*
* The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets
* (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2',
* 'ftpext' or 'ftpsockets'.
*
* The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
* or filtering via {@see 'filesystem_method'}.
*
* @link https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#wordpress-upgrade-constants
*
* Plugins may define a custom transport handler, See WP_Filesystem().
*
* @since 2.5.0
*
* @global callable $_wp_filesystem_direct_method
*
* @param array  $args                         Optional. Connection details. Default empty array.
* @param string $context                      Optional. Full path to the directory that is tested
*                                             for being writable. Default empty.
* @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.
*/
2261function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) {
// Please ensure that this is either 'direct', 'ssh2', 'ftpext', or 'ftpsockets'.
$method = defined( 'FS_METHOD' ) ? FS_METHOD : false;
2264
if ( ! $context ) {
$context = WP_CONTENT_DIR;
}
2268
// If the directory doesn't exist (wp-content/languages) then use the parent directory as we'll create it.
if ( WP_LANG_DIR === $context && ! is_dir( $context ) ) {
$context = dirname( $context );
}
2273
$context = trailingslashit( $context );
2275
if ( ! $method ) {
2277
$temp_file_name = $context . 'temp-write-test-' . str_replace( '.', '-', uniqid( '', true ) );
$temp_handle    = @fopen( $temp_file_name, 'w' );
if ( $temp_handle ) {
2281
	// Attempt to determine the file owner of the WordPress files, and that of newly created files.
	$wp_file_owner   = false;
	$temp_file_owner = false;
	if ( function_exists( 'fileowner' ) ) {
		$wp_file_owner   = @fileowner( __FILE__ );
		$temp_file_owner = @fileowner( $temp_file_name );
	}
2289
	if ( false !== $wp_file_owner && $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';
		$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';
		$GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
	}
2306
	fclose( $temp_handle );
	@unlink( $temp_file_name );
}
}
2311
if ( ! $method && isset( $args['connection_type'] ) && 'ssh' === $args['connection_type'] && extension_loaded( 'ssh2' ) ) {
$method = 'ssh2';
}
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.
}
2321
/**
* Filters the filesystem method to use.
*
* @since 2.6.0
*
* @param string $method                       Filesystem method to return.
* @param array  $args                         An array of connection details for the method.
* @param string $context                      Full path to the directory that is tested for being writable.
* @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
return apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership );
2333}
2334
2335/**
* Displays a form to the user to request for their FTP/SSH details in order
* to connect to the filesystem.
*
* All chosen/entered details are saved, excluding the password.
*
* Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
* to specify an alternate FTP/SSH port.
*
* Plugins may override this form by returning true|false via the {@see 'request_filesystem_credentials'} filter.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @global string $pagenow The filename of the current screen.
*
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Optional. Chosen type of filesystem. Default empty.
* @param bool|WP_Error $error                        Optional. Whether the current request has failed
*                                                    to connect, or an error object. Default false.
* @param string        $context                      Optional. Full path to the directory that is tested
*                                                    for being 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|array True if no filesystem credentials are required,
*                    false if they are required but have not been provided,
*                    array of credentials if they are required and have been provided.
*/
2365function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
global $pagenow;
2367
/**
* Filters the filesystem credentials.
*
* Returning anything other than an empty string will effectively short-circuit
* output of the filesystem credentials form, returning that value instead.
*
* A filter should return true if no filesystem credentials are required, false if they are required but have not been
* provided, or an array of credentials if they are required and have been provided.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param mixed         $credentials                  Credentials to return instead. Default empty string.
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Chosen type of filesystem.
* @param bool|WP_Error $error                        Whether the current request has failed to connect,
*                                                    or an error object.
* @param string        $context                      Full path to the directory that is tested for
*                                                    being writable.
* @param array         $extra_fields                 Extra POST fields.
* @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
2391
if ( '' !== $req_cred ) {
return $req_cred;
}
2395
if ( empty( $type ) ) {
$type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
}
2399
if ( 'direct' === $type ) {
return true;
}
2403
if ( is_null( $extra_fields ) ) {
$extra_fields = array( 'version', 'locale' );
}
2407
$credentials = get_option(
'ftp_credentials',
array(
	'hostname' => '',
	'username' => '',
)
);
2415
$submitted_form = wp_unslash( $_POST );
2417
// Verify nonce, or unset submitted form field values on failure.
if ( ! isset( $_POST['_fs_nonce'] ) || ! wp_verify_nonce( $_POST['_fs_nonce'], 'filesystem-credentials' ) ) {
unset(
	$submitted_form['hostname'],
	$submitted_form['username'],
	$submitted_form['password'],
	$submitted_form['public_key'],
	$submitted_form['private_key'],
	$submitted_form['connection_type']
);
}
2429
$ftp_constants = array(
'hostname'    => 'FTP_HOST',
'username'    => 'FTP_USER',
'password'    => 'FTP_PASS',
'public_key'  => 'FTP_PUBKEY',
'private_key' => 'FTP_PRIKEY',
);
2437
/*
* If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string.
* Otherwise, keep it as it previously was (saved details in option).
*/
foreach ( $ftp_constants as $key => $constant ) {
if ( defined( $constant ) ) {
	$credentials[ $key ] = constant( $constant );
} elseif ( ! empty( $submitted_form[ $key ] ) ) {
	$credentials[ $key ] = $submitted_form[ $key ];
} elseif ( ! isset( $credentials[ $key ] ) ) {
	$credentials[ $key ] = '';
}
}
2451
// Sanitize the hostname, some people might pass in odd data.
$credentials['hostname'] = preg_replace( '|\w+://|', '', $credentials['hostname'] ); // Strip any schemes off.
2454
if ( strpos( $credentials['hostname'], ':' ) ) {
list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 );
if ( ! is_numeric( $credentials['port'] ) ) {
	unset( $credentials['port'] );
}
} else {
unset( $credentials['port'] );
}
2463
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.
$credentials['connection_type'] = 'ftps';
} elseif ( ! empty( $submitted_form['connection_type'] ) ) {
$credentials['connection_type'] = $submitted_form['connection_type'];
} elseif ( ! isset( $credentials['connection_type'] ) ) { // All else fails (and it's not defaulted to something else saved), default to FTP.
$credentials['connection_type'] = 'ftp';
}
2473
if ( ! $error
&& ( ! empty( $credentials['hostname'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['password'] )
	|| 'ssh' === $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] )
)
) {
$stored_credentials = $credentials;
2480
if ( ! empty( $stored_credentials['port'] ) ) { // Save port as part of hostname to simplify above code.
	$stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
}
2484
unset(
	$stored_credentials['password'],
	$stored_credentials['port'],
	$stored_credentials['private_key'],
	$stored_credentials['public_key']
);
2491
if ( ! wp_installing() ) {
	update_option( 'ftp_credentials', $stored_credentials, false );
}
2495
return $credentials;
}
2498
$hostname        = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
$username        = isset( $credentials['username'] ) ? $credentials['username'] : '';
$public_key      = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
$private_key     = isset( $credentials['private_key'] ) ? $credentials['private_key'] : '';
$port            = isset( $credentials['port'] ) ? $credentials['port'] : '';
$connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : '';
2505
if ( $error ) {
$error_string = __( '<strong>Error:</strong> Could not connect to the server. Please verify the settings are correct.' );
if ( is_wp_error( $error ) ) {
	$error_string = esc_html( $error->get_error_message() );
}
wp_admin_notice(
	$error_string,
	array(
		'id'                 => 'message',
		'additional_classes' => array( 'error' ),
	)
);
}
2519
$types = array();
if ( extension_loaded( 'ftp' ) || extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) {
$types['ftp'] = __( 'FTP' );
}
if ( extension_loaded( 'ftp' ) ) { // Only this supports FTPS.
$types['ftps'] = __( 'FTPS (SSL)' );
}
if ( extension_loaded( 'ssh2' ) ) {
$types['ssh'] = __( 'SSH2' );
}
2530
/**
* Filters the connection types to output to the filesystem credentials form.
*
* @since 2.9.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param string[]      $types       Types of connections.
* @param array         $credentials Credentials to connect with.
* @param string        $type        Chosen filesystem method.
* @param bool|WP_Error $error       Whether the current request has failed to connect,
*                                   or an error object.
* @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 );
?>
2546<form action="<?php echo esc_url( $form_post ); ?>" method="post">
2547<div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form">
<?php
// Print a H1 heading in the FTP credentials modal dialog, default is a H2.
$heading_tag = 'h2';
if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) {
$heading_tag = 'h1';
}
echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>";
?>
2556<p id="request-filesystem-credentials-desc">
<?php
$label_user = __( 'Username' );
$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.' );
	$label_user = __( 'FTP/SSH Username' );
	$label_pass = __( 'FTP/SSH Password' );
} else {
	_e( 'Please enter your FTP credentials to proceed.' );
	$label_user = __( 'FTP Username' );
	$label_pass = __( 'FTP Password' );
}
echo ' ';
}
_e( 'If you do not remember your credentials, you should contact your web host.' );
2575
$hostname_value = esc_attr( $hostname );
if ( ! empty( $port ) ) {
$hostname_value .= ":$port";
}
2580
$password_value = '';
if ( defined( 'FTP_PASS' ) ) {
$password_value = '*****';
}
?>
2586</p>
2587<label for="hostname">
<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 $hostname_value; ?>"<?php disabled( defined( 'FTP_HOST' ) ); ?> />
2590</label>
2591<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' ) ); ?> />
</label>
2596</div>
2597<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 echo $password_value; ?>"<?php disabled( defined( 'FTP_PASS' ) ); ?> spellcheck="false" />
<?php
if ( ! defined( 'FTP_PASS' ) ) {
	_e( 'This password will not be stored on the server.' );
}
?>
</label>
2607</div>
2608<fieldset>
2609<legend><?php _e( 'Connection Type' ); ?></legend>
<?php
$disabled = disabled( ( defined( 'FTP_SSL' ) && FTP_SSL ) || ( defined( 'FTP_SSH' ) && FTP_SSH ), true, false );
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 ); ?> <?php echo $disabled; ?> />
<?php echo $text; ?>
</label>
<?php
endforeach;
?>
2621</fieldset>
<?php
if ( isset( $types['ssh'] ) ) {
$hidden_class = '';
if ( 'ssh' !== $connection_type ) {
	$hidden_class = ' class="hidden"';
}
?>
2629<fieldset id="ssh-keys"<?php echo $hidden_class; ?>>
2630<legend><?php _e( 'Authentication Keys' ); ?></legend>
2631<label for="public_key">
<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' ) ); ?> />
2634</label>
2635<label for="private_key">
<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' ) ); ?> />
2638</label>
2639<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>
2640</fieldset>
<?php
}
2643
foreach ( (array) $extra_fields as $field ) {
if ( isset( $submitted_form[ $field ] ) ) {
	echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( $submitted_form[ $field ] ) . '" />';
}
}
2649
/*
* Make sure the `submit_button()` function is available during the REST API call
* from WP_Site_Health_Auto_Updates::test_check_wp_filesystem_method().
*/
if ( ! function_exists( 'submit_button' ) ) {
require_once ABSPATH . 'wp-admin/includes/template.php';
}
?>
<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' ), 'primary', 'upgrade', false ); ?>
</p>
2663</div>
2664</form>
<?php
return false;
2667}
2668
2669/**
* Prints the filesystem credentials modal when needed.
*
* @since 4.2.0
*/
2674function wp_print_request_filesystem_credentials_modal() {
$filesystem_method = get_filesystem_method();
2676
ob_start();
$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
ob_end_clean();
2680
$request_filesystem_credentials = ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored );
if ( ! $request_filesystem_credentials ) {
return;
}
?>
<div id="request-filesystem-credentials-dialog" class="notification-dialog-wrap request-filesystem-credentials-dialog">
<div class="notification-dialog-background"></div>
<div class="notification-dialog" role="dialog" aria-labelledby="request-filesystem-credentials-title" tabindex="0">
	<div class="request-filesystem-credentials-dialog-content">
		<?php request_filesystem_credentials( site_url() ); ?>
	</div>
</div>
</div>
<?php
2695}
2696
2697/**
* Attempts to clear the opcode cache for an individual PHP file.
*
* This function can be called safely without having to check the file extension
* or availability of the OPcache extension.
*
* Whether or not invalidation is possible is cached to improve performance.
*
* @since 5.5.0
*
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @param string $filepath Path to the file, including extension, for which the opcode cache is to be cleared.
* @param bool   $force    Invalidate even if the modification time is not newer than the file in cache.
*                         Default false.
* @return bool True if opcache was invalidated for `$filepath`, or there was nothing to invalidate.
*              False if opcache invalidation is not available, or is disabled via filter.
*/
2715function wp_opcache_invalidate( $filepath, $force = false ) {
static $can_invalidate = null;
2717
/*
* Check to see if WordPress is able to run `opcache_invalidate()` or not, and cache the value.
*
* First, check to see if the function is available to call, then if the host has restricted
* the ability to run the function to avoid a PHP warning.
*
* `opcache.restrict_api` can specify the path for files allowed to call `opcache_invalidate()`.
*
* If the host has this set, check whether the path in `opcache.restrict_api` matches
* the beginning of the path of the origin file.
*
* `$_SERVER['SCRIPT_FILENAME']` approximates the origin file's path, but `realpath()`
* is necessary because `SCRIPT_FILENAME` can be a relative path when run from CLI.
*
* For more details, see:
* - https://www.php.net/manual/en/opcache.configuration.php
* - https://www.php.net/manual/en/reserved.variables.server.php
* - https://core.trac.wordpress.org/ticket/36455
*/
if ( null === $can_invalidate
&& function_exists( 'opcache_invalidate' )
&& ( ! ini_get( 'opcache.restrict_api' )
	|| stripos( realpath( $_SERVER['SCRIPT_FILENAME'] ), ini_get( 'opcache.restrict_api' ) ) === 0 )
) {
$can_invalidate = true;
}
2744
// If invalidation is not available, return early.
if ( ! $can_invalidate ) {
return false;
}
2749
// Verify that file to be invalidated has a PHP extension.
if ( '.php' !== strtolower( substr( $filepath, -4 ) ) ) {
return false;
}
2754
/**
* Filters whether to invalidate a file from the opcode cache.
*
* @since 5.5.0
*
* @param bool   $will_invalidate Whether WordPress will invalidate `$filepath`. Default true.
* @param string $filepath        The path to the PHP file to invalidate.
*/
if ( apply_filters( 'wp_opcache_invalidate_file', true, $filepath ) ) {
return opcache_invalidate( $filepath, $force );
}
2766
return false;
2768}
2769
2770/**
* Attempts to clear the opcode cache for a directory of files.
*
* @since 6.2.0
*
* @see wp_opcache_invalidate()
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $dir The path to the directory for which the opcode cache is to be cleared.
*/
2782function wp_opcache_invalidate_directory( $dir ) {
global $wp_filesystem;
2784
if ( ! is_string( $dir ) || '' === trim( $dir ) ) {
if ( WP_DEBUG ) {
	$error_message = sprintf(
		/* translators: %s: The function name. */
		__( '%s expects a non-empty string.' ),
		'<code>wp_opcache_invalidate_directory()</code>'
	);
	wp_trigger_error( '', $error_message );
}
return;
}
2796
$dirlist = $wp_filesystem->dirlist( $dir, false, true );
2798
if ( empty( $dirlist ) ) {
return;
}
2802
/*
* Recursively invalidate opcache of files in a directory.
*
* WP_Filesystem_*::dirlist() returns an array of file and directory information.
*
* This does not include a path to the file or directory.
* To invalidate files within sub-directories, recursion is needed
* to prepend an absolute path containing the sub-directory's name.
*
* @param array  $dirlist Array of file/directory information from WP_Filesystem_Base::dirlist(),
*                        with sub-directories represented as nested arrays.
* @param string $path    Absolute path to the directory.
*/
$invalidate_directory = static function ( $dirlist, $path ) use ( &$invalidate_directory ) {
$path = trailingslashit( $path );
2818
foreach ( $dirlist as $name => $details ) {
	if ( 'f' === $details['type'] ) {
		wp_opcache_invalidate( $path . $name, true );
	} elseif ( is_array( $details['files'] ) && ! empty( $details['files'] ) ) {
		$invalidate_directory( $details['files'], $path . $name );
	}
}
};
2827
$invalidate_directory( $dirlist, $dir );
2829}
2830

Before1<?php
2/**
* Filesystem API: Top-level functionality
*
* Functions for reading, writing, modifying, and deleting files on the file system.
* Includes functionality for theme-specific files as well as operations for uploading,
* archiving, and rendering output when necessary.
*
* @package WordPress
* @subpackage Filesystem
* @since 2.3.0
*/
13
14/** The descriptions for theme files. */
15$wp_file_descriptions = array(
'functions.php'         => __( 'Theme Functions' ),
'header.php'            => __( 'Theme Header' ),
'footer.php'            => __( 'Theme Footer' ),
'sidebar.php'           => __( 'Sidebar' ),
'comments.php'          => __( 'Comments' ),
'searchform.php'        => __( 'Search Form' ),
'404.php'               => __( '404 Template' ),
'link.php'              => __( 'Links Template' ),
'theme.json'            => __( 'Theme Styles & Block Settings' ),
// Archives.
'index.php'             => __( 'Main Index Template' ),
'archive.php'           => __( 'Archives' ),
'author.php'            => __( 'Author Template' ),
'taxonomy.php'          => __( 'Taxonomy Template' ),
'category.php'          => __( 'Category Template' ),
'tag.php'               => __( 'Tag Template' ),
'home.php'              => __( 'Posts Page' ),
'search.php'            => __( 'Search Results' ),
'date.php'              => __( 'Date Template' ),
// 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' ),
'application.php'       => __( 'Application Attachment Template' ),
// Embeds.
'embed.php'             => __( 'Embed Template' ),
'embed-404.php'         => __( 'Embed 404 Template' ),
'embed-content.php'     => __( 'Embed Content Template' ),
'header-embed.php'      => __( 'Embed Header Template' ),
'footer-embed.php'      => __( 'Embed Footer Template' ),
// Stylesheets.
'style.css'             => __( 'Stylesheet' ),
'editor-style.css'      => __( 'Visual Editor Stylesheet' ),
'editor-style-rtl.css'  => __( 'Visual Editor RTL Stylesheet' ),
'rtl.css'               => __( 'RTL Stylesheet' ),
// Other.
'my-hacks.php'          => __( 'my-hacks.php (legacy hacks support)' ),
'.htaccess'             => __( '.htaccess (for rewrite rules )' ),
// Deprecated files.
'wp-layout.css'         => __( 'Stylesheet' ),
'wp-comments.php'       => __( 'Comments Template' ),
'wp-comments-popup.php' => __( 'Popup Comments Template' ),
'comments-popup.php'    => __( 'Popup Comments' ),
66);
67
68/**
* Gets the description for standard WordPress theme files.
*
* @since 1.5.0
*
* @global array $wp_file_descriptions Theme file descriptions.
* @global array $allowed_files        List of allowed files.
*
* @param string $file Filesystem path or filename.
* @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist.
*                Appends 'Page Template' to basename of $file if the file is a page template.
*/
80function get_file_description( $file ) {
global $wp_file_descriptions, $allowed_files;
82
$dirname   = pathinfo( $file, PATHINFO_DIRNAME );
$file_path = $allowed_files[ $file ];
85
if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) {
return $wp_file_descriptions[ basename( $file ) ];
} elseif ( file_exists( $file_path ) && is_file( $file_path ) ) {
$template_data = implode( '', file( $file_path ) );
90
if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) {
	/* translators: %s: Template name. */
	return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
}
}
96
return trim( basename( $file ) );
98}
99
100/**
* Gets the absolute filesystem path to the root of the WordPress installation.
*
* @since 1.5.0
*
* @return string Full filesystem path to the root of the WordPress installation.
*/
107function get_home_path() {
$home    = set_url_scheme( get_option( 'home' ), 'http' );
$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );
110
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 ) );
$home_path           = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
$home_path           = trailingslashit( $home_path );
} else {
$home_path = ABSPATH;
}
119
return str_replace( '\\', '/', $home_path );
121}
122
123/**
* Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
*
* The depth of the recursiveness can be controlled by the $levels param.
*
* @since 2.6.0
* @since 4.9.0 Added the `$exclusions` parameter.
* @since 6.3.0 Added the `$include_hidden` parameter.
*
* @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 string[] $exclusions     Optional. List of folders and files to skip.
* @param bool     $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
*                                 Default false.
* @return string[]|false Array of files on success, false on failure.
*/
139function list_files( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false ) {
if ( empty( $folder ) ) {
return false;
}
143
$folder = trailingslashit( $folder );
145
if ( ! $levels ) {
return false;
}
149
$files = array();
151
$dir = @opendir( $folder );
153
if ( $dir ) {
while ( ( $file = readdir( $dir ) ) !== false ) {
	// Skip current and parent folder links.
	if ( in_array( $file, array( '.', '..' ), true ) ) {
		continue;
	}
160
	// Skip hidden and excluded files.
	if ( ( ! $include_hidden && '.' === $file[0] ) || in_array( $file, $exclusions, true ) ) {
		continue;
	}
165
	if ( is_dir( $folder . $file ) ) {
		$files2 = list_files( $folder . $file, $levels - 1, array(), $include_hidden );
		if ( $files2 ) {
			$files = array_merge( $files, $files2 );
		} else {
			$files[] = $folder . $file . '/';
		}
	} else {
		$files[] = $folder . $file;
	}
}
177
closedir( $dir );
}
180
return $files;
182}
183
184/**
* Gets the list of file extensions that are editable in plugins.
*
* @since 4.9.0
*
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return string[] Array of editable file extensions.
*/
192function wp_get_plugin_file_editable_extensions( $plugin ) {
193
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
228
/**
* Filters the list of file types allowed for editing in the plugin file editor.
*
* @since 2.8.0
* @since 4.9.0 Added the `$plugin` parameter.
*
* @param string[] $default_types An array of editable plugin file extensions.
* @param string   $plugin        Path to the plugin file relative to the plugins directory.
*/
$file_types = (array) apply_filters( 'editable_extensions', $default_types, $plugin );
239
return $file_types;
241}
242
243/**
* Gets the list of file extensions that are editable for a given theme.
*
* @since 4.9.0
*
* @param WP_Theme $theme Theme object.
* @return string[] Array of editable file extensions.
*/
251function wp_get_theme_file_editable_extensions( $theme ) {
252
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
287
/**
* Filters the list of file types allowed for editing in the theme file editor.
*
* @since 4.4.0
*
* @param string[] $default_types An array of editable theme file extensions.
* @param WP_Theme $theme         The active theme object.
*/
$file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme );
297
// Ensure that default types are still there.
return array_unique( array_merge( $file_types, $default_types ) );
300}
301
302/**
* Prints file editor templates (for plugins and themes).
*
* @since 4.9.0
*/
307function wp_print_file_editor_templates() {
?>
<script type="text/html" id="tmpl-wp-file-editor-notice">
<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: 1: Line number, 2: File path. */
				__( 'Your PHP code changes were not applied due to an error on line %1$s of file %2$s. Please fix and try saving again.' ),
				'{{ data.line }}',
				'{{ data.file }}'
			);
			?>
		</p>
		<pre>{{ data.message }}</pre>
	<# } else if ( 'file_not_writable' === data.code ) { #>
		<p>
			<?php
			printf(
				/* translators: %s: Documentation URL. */
				__( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ),
				__( 'https://developer.wordpress.org/advanced-administration/server/file-permissions/' )
			);
			?>
		</p>
	<# } else { #>
		<p>{{ data.message || data.code }}</p>
335
		<# if ( 'lint_errors' === data.code ) { #>
			<p>
				<# var elementId = 'el-' + String( Math.random() ); #>
				<input id="{{ elementId }}"  type="checkbox">
				<label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label>
			</p>
		<# } #>
	<# } #>
	<# if ( data.dismissible ) { #>
		<button type="button" class="notice-dismiss"><span class="screen-reader-text">
			<?php
			/* translators: Hidden accessibility text. */
			_e( 'Dismiss' );
			?>
		</span></button>
	<# } #>
</div>
</script>
<?php
355}
356
357/**
* Attempts to edit a file for a theme or plugin.
*
* When editing a PHP file, loopback requests will be made to the admin and the homepage
* to attempt to see if there is a fatal error introduced. If so, the PHP change will be
* reverted.
*
* @since 4.9.0
*
* @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.
*
*     @type string $file       Relative path to file.
*     @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.
*/
378function wp_edit_theme_plugin_file( $args ) {
if ( empty( $args['file'] ) ) {
return new WP_Error( 'missing_file' );
}
382
if ( 0 !== validate_file( $args['file'] ) ) {
return new WP_Error( 'bad_file' );
}
386
if ( ! isset( $args['newcontent'] ) ) {
return new WP_Error( 'missing_content' );
}
390
if ( ! isset( $args['nonce'] ) ) {
return new WP_Error( 'missing_nonce' );
}
394
$file    = $args['file'];
$content = $args['newcontent'];
397
$plugin    = null;
$theme     = null;
$real_file = null;
401
if ( ! empty( $args['plugin'] ) ) {
$plugin = $args['plugin'];
404
if ( ! current_user_can( 'edit_plugins' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit plugins for this site.' ) );
}
408
if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
412
if ( ! array_key_exists( $plugin, get_plugins() ) ) {
	return new WP_Error( 'invalid_plugin' );
}
416
if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {
	return new WP_Error( 'bad_plugin_file_path', __( 'Sorry, that file cannot be edited.' ) );
}
420
$editable_extensions = wp_get_plugin_file_editable_extensions( $plugin );
422
$real_file = WP_PLUGIN_DIR . '/' . $file;
424
$is_active = in_array(
	$plugin,
	(array) get_option( 'active_plugins', array() ),
	true
);
430
} elseif ( ! empty( $args['theme'] ) ) {
$stylesheet = $args['theme'];
433
if ( 0 !== validate_file( $stylesheet ) ) {
	return new WP_Error( 'bad_theme_path' );
}
437
if ( ! current_user_can( 'edit_themes' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit templates for this site.' ) );
}
441
$theme = wp_get_theme( $stylesheet );
if ( ! $theme->exists() ) {
	return new WP_Error( 'non_existent_theme', __( 'The requested theme does not exist.' ) );
}
446
if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
450
if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) {
	return new WP_Error(
		'theme_no_stylesheet',
		__( 'The requested theme does not exist.' ) . ' ' . $theme->errors()->get_error_message()
	);
}
457
$editable_extensions = wp_get_theme_file_editable_extensions( $theme );
459
$allowed_files = array();
foreach ( $editable_extensions as $type ) {
	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 );
			$allowed_files['style.css'] = $style_files['style.css'];
			$allowed_files              = array_merge( $allowed_files, $style_files );
			break;
		default:
			$allowed_files = array_merge( $allowed_files, $theme->get_files( $type, -1 ) );
			break;
	}
}
476
// 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.' ) );
}
481
$real_file = $theme->get_stylesheet_directory() . '/' . $file;
483
$is_active = ( get_stylesheet() === $stylesheet || get_template() === $stylesheet );
485
} else {
return new WP_Error( 'missing_theme_or_plugin' );
}
489
// Ensure file is real.
if ( ! is_file( $real_file ) ) {
return new WP_Error( 'file_does_not_exist', __( 'File does not exist! Please double check the name and try again.' ) );
}
494
// Ensure file extension is allowed.
$extension = null;
if ( preg_match( '/\.([^.]+)$/', $real_file, $matches ) ) {
$extension = strtolower( $matches[1] );
if ( ! in_array( $extension, $editable_extensions, true ) ) {
	return new WP_Error( 'illegal_file_type', __( 'Files of this type are not editable.' ) );
}
}
503
$previous_content = file_get_contents( $real_file );
505
if ( ! is_writable( $real_file ) ) {
return new WP_Error( 'file_not_writable' );
}
509
$f = fopen( $real_file, 'w+' );
511
if ( false === $f ) {
return new WP_Error( 'file_not_writable' );
}
515
$written = fwrite( $f, $content );
fclose( $f );
518
if ( false === $written ) {
return new WP_Error( 'unable_to_write', __( 'Unable to write to file.' ) );
}
522
wp_opcache_invalidate( $real_file, true );
524
if ( $is_active && 'php' === $extension ) {
526
$scrape_key   = md5( rand() );
$transient    = 'scrape_key_' . $scrape_key;
$scrape_nonce = (string) rand();
// It shouldn't take more than 60 seconds to make the two loopback requests.
set_transient( $transient, $scrape_nonce, 60 );
532
$cookies       = wp_unslash( $_COOKIE );
$scrape_params = array(
	'wp_scrape_key'   => $scrape_key,
	'wp_scrape_nonce' => $scrape_nonce,
);
$headers       = array(
	'Cache-Control' => 'no-cache',
);
541
/** This filter is documented in wp-includes/class-wp-http-streams.php */
$sslverify = apply_filters( 'https_local_ssl_verify', false );
544
// Include Basic auth in loopback requests.
if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
	$headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );
}
549
// Make sure PHP process doesn't die before loopback requests complete.
if ( function_exists( 'set_time_limit' ) ) {
	set_time_limit( 5 * MINUTE_IN_SECONDS );
}
554
// Time to wait for loopback requests to finish.
$timeout = 100; // 100 seconds.
557
$needle_start = "###### wp_scraping_result_start:$scrape_key ######";
$needle_end   = "###### wp_scraping_result_end:$scrape_key ######";
560
// 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,
		),
		admin_url( 'theme-editor.php' )
	);
} else {
	$url = admin_url();
}
575
if ( function_exists( 'session_status' ) && PHP_SESSION_ACTIVE === session_status() ) {
	/*
	 * Close any active session to prevent HTTP requests from timing out
	 * when attempting to connect back to the site.
	 */
	session_write_close();
}
583
$url                    = add_query_arg( $scrape_params, $url );
$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
$body                   = wp_remote_retrieve_body( $r );
$scrape_result_position = strpos( $body, $needle_start );
588
$loopback_request_failure = array(
	'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(
	'code' => 'json_parse_error',
);
596
$result = null;
598
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 );
	if ( empty( $result ) ) {
		$result = $json_parse_failure;
	}
}
609
// Try making request to homepage as well to see if visitors have been whitescreened.
if ( true === $result ) {
	$url                    = home_url( '/' );
	$url                    = add_query_arg( $scrape_params, $url );
	$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
	$body                   = wp_remote_retrieve_body( $r );
	$scrape_result_position = strpos( $body, $needle_start );
617
	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 );
		if ( empty( $result ) ) {
			$result = $json_parse_failure;
		}
	}
}
629
delete_transient( $transient );
631
if ( true !== $result ) {
	// Roll-back file change.
	file_put_contents( $real_file, $previous_content );
	wp_opcache_invalidate( $real_file, true );
636
	if ( ! isset( $result['message'] ) ) {
		$message = __( 'An error occurred. Please try again later.' );
	} else {
		$message = $result['message'];
		unset( $result['message'] );
	}
643
	return new WP_Error( 'php_error', $message, $result );
}
}
647
if ( $theme instanceof WP_Theme ) {
$theme->cache_delete();
}
651
return true;
653}
654
655
656/**
* Returns a filename of a temporary unique file.
*
* Please note that the calling function must delete or move the file.
*
* The filename is based off the passed parameter or defaults to the current unix timestamp,
* while the directory can either be passed as well, or by leaving it blank, default to a writable
* temporary directory.
*
* @since 2.6.0
*
* @param string $filename Optional. Filename to base the Unique file off. Default empty.
* @param string $dir      Optional. Directory to store the file in. Default empty.
* @return string A writable filename.
*/
671function wp_tempnam( $filename = '', $dir = '' ) {
if ( empty( $dir ) ) {
$dir = get_temp_dir();
}
675
if ( empty( $filename ) || in_array( $filename, array( '.', '/', '\\' ), true ) ) {
$filename = uniqid();
}
679
// 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 );
683
// If the folder is falsey, use its parent directory name instead.
if ( ! $temp_filename ) {
return wp_tempnam( dirname( $filename ), $dir );
}
688
// Suffix some random data to avoid filename conflicts.
$temp_filename .= '-' . wp_generate_password( 6, false );
$temp_filename .= '.tmp';
$temp_filename  = wp_unique_filename( $dir, $temp_filename );
693
/*
* Filesystems typically have a limit of 255 characters for a filename.
*
* If the generated unique filename exceeds this, truncate the initial
* filename and try again.
*
* As it's possible that the truncated filename may exist, producing a
* suffix of "-1" or "-10" which could exceed the limit again, truncate
* it to 252 instead.
*/
$characters_over_limit = strlen( $temp_filename ) - 252;
if ( $characters_over_limit > 0 ) {
$filename = substr( $filename, 0, -$characters_over_limit );
return wp_tempnam( $filename, $dir );
}
709
$temp_filename = $dir . $temp_filename;
711
$fp = @fopen( $temp_filename, 'x' );
713
if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) {
return wp_tempnam( $filename, $dir );
}
717
if ( $fp ) {
fclose( $fp );
}
721
return $temp_filename;
723}
724
725/**
* Makes sure that the file that was requested to be edited is allowed to be edited.
*
* 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[] $allowed_files Optional. Array of allowed files to edit.
*                                `$file` must match an entry exactly.
* @return string|void Returns the file name on success, dies on failure.
*/
737function validate_file_to_edit( $file, $allowed_files = array() ) {
$code = validate_file( $file, $allowed_files );
739
if ( ! $code ) {
return $file;
}
743
switch ( $code ) {
case 1:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
747
	// case 2 :
	// wp_die( __('Sorry, cannot call files with their real path.' ));
750
case 3:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
}
754}
755
756/**
* Handles PHP uploads in WordPress.
*
* Sanitizes file names, checks extensions for mime type, and moves the file
* to the appropriate directory within the uploads directory.
*
* @access private
* @since 4.0.0
*
* @see wp_handle_upload_error
*
* @param array       $file      {
*     Reference to a single element from `$_FILES`. Call the function once for each uploaded file.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param array|false $overrides {
*     An array of override parameters for this file, or boolean false if none are provided.
*
*     @type callable $upload_error_handler     Function to call when there is an error during the upload process.
*                                              See {@see wp_handle_upload_error()}.
*     @type callable $unique_filename_callback Function to call when determining a unique file name for the file.
*                                              See {@see wp_unique_filename()}.
*     @type string[] $upload_error_strings     The strings that describe the error indicated in
*                                              `$_FILES[{form field}]['error']`.
*     @type bool     $test_form                Whether to test that the `$_POST['action']` parameter is as expected.
*     @type bool     $test_size                Whether to test that the file size is greater than zero bytes.
*     @type bool     $test_type                Whether to test that the mime type of the file is as expected.
*     @type string[] $mimes                    Array of allowed mime types keyed by their file extension regex.
* }
* @param string      $time      Time formatted in 'yyyy/mm'.
* @param string      $action    Expected value for `$_POST['action']`.
* @return array {
*     On success, returns an associative array of file attributes.
*     On failure, returns `$overrides['upload_error_handler']( &$file, $message )`
*     or `array( 'error' => $message )`.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
*/
802function _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 ) {
	return array( 'error' => $message );
}
}
809
/**
* Filters the data for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_prefilter`
*  - `wp_handle_upload_prefilter`
*
* @since 2.9.0 as 'wp_handle_upload_prefilter'.
* @since 4.0.0 Converted to a dynamic hook with `$action`.
*
* @param array $file {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$file = apply_filters( "{$action}_prefilter", $file );
834
/**
* Filters the override parameters for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_overrides`
*  - `wp_handle_upload_overrides`
*
* @since 5.7.0
*
* @param array|false $overrides An array of override parameters for this file. Boolean false if none are
*                               provided. See {@see _wp_handle_upload()}.
* @param array       $file      {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$overrides = apply_filters( "{$action}_overrides", $overrides, $file );
860
// You may define your own function and pass the name in $overrides['upload_error_handler'].
$upload_error_handler = 'wp_handle_upload_error';
if ( isset( $overrides['upload_error_handler'] ) ) {
$upload_error_handler = $overrides['upload_error_handler'];
}
866
// You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully.
if ( isset( $file['error'] ) && ! is_numeric( $file['error'] ) && $file['error'] ) {
return call_user_func_array( $upload_error_handler, array( &$file, $file['error'] ) );
}
871
// Install user overrides. Did we mention that this voids your warranty?
873
// You may define your own function and pass the name in $overrides['unique_filename_callback'].
$unique_filename_callback = null;
if ( isset( $overrides['unique_filename_callback'] ) ) {
$unique_filename_callback = $overrides['unique_filename_callback'];
}
879
/*
* This may not have originally been intended to be overridable,
* but historically has been.
*/
if ( isset( $overrides['upload_error_strings'] ) ) {
$upload_error_strings = $overrides['upload_error_strings'];
} else {
// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
$upload_error_strings = array(
	false,
	sprintf(
		/* translators: 1: upload_max_filesize, 2: php.ini */
		__( 'The uploaded file exceeds the %1$s directive in %2$s.' ),
		'upload_max_filesize',
		'php.ini'
	),
	sprintf(
		/* translators: %s: MAX_FILE_SIZE */
		__( 'The uploaded file exceeds the %s directive that was specified in the HTML form.' ),
		'MAX_FILE_SIZE'
	),
	__( '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.' ),
);
}
909
// 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;
913
// 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'] : null;
917
// 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.' ) ) );
}
922
// 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'] ] ) );
}
927
// 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.' ) ) );
}
933
$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 ) ) {
if ( is_multisite() ) {
	$error_msg = __( 'File is empty. Please upload something more substantial.' );
} else {
	$error_msg = sprintf(
		/* translators: 1: php.ini, 2: post_max_size, 3: upload_max_filesize */
		__( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your %1$s file or by %2$s being defined as smaller than %3$s in %1$s.' ),
		'php.ini',
		'post_max_size',
		'upload_max_filesize'
	);
}
948
return call_user_func_array( $upload_error_handler, array( &$file, $error_msg ) );
}
951
// 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 );
$ext             = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext'];
$type            = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type'];
$proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename'];
958
// Check to see if wp_check_filetype_and_ext() determined the filename was incorrect.
if ( $proper_filename ) {
	$file['name'] = $proper_filename;
}
963
if ( ( ! $type || ! $ext ) && ! current_user_can( 'unfiltered_upload' ) ) {
	return call_user_func_array( $upload_error_handler, array( &$file, __( 'Sorry, you are not allowed to upload this file type.' ) ) );
}
967
if ( ! $type ) {
	$type = $file['type'];
}
} else {
$type = '';
}
974
/*
* A writable uploads dir will pass this test. Again, there's no point
* overriding this one.
*/
$uploads = wp_upload_dir( $time );
if ( ! ( $uploads && false === $uploads['error'] ) ) {
return call_user_func_array( $upload_error_handler, array( &$file, $uploads['error'] ) );
}
983
$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
985
// Move the file to the uploads dir.
$new_file = $uploads['path'] . "/$filename";
988
/**
* Filters whether to short-circuit moving the uploaded file after passing all checks.
*
* If a non-null value is returned from the filter, moving the file and any related
* error reporting will be completely skipped.
*
* @since 4.9.0
*
* @param mixed    $move_new_file If null (default) move the file after the upload.
* @param array    $file          {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param string   $new_file      Filename of the newly-uploaded file.
* @param string   $type          Mime type of the newly-uploaded file.
*/
$move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type );
1011
if ( null === $move_new_file ) {
if ( 'wp_handle_upload' === $action ) {
	$move_new_file = @move_uploaded_file( $file['tmp_name'], $new_file );
} else {
	// Use copy and unlink because rename breaks streams.
	// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
	$move_new_file = @copy( $file['tmp_name'], $new_file );
	unlink( $file['tmp_name'] );
}
1021
if ( false === $move_new_file ) {
	if ( str_starts_with( $uploads['basedir'], ABSPATH ) ) {
		$error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
	} else {
		$error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
	}
1028
	return $upload_error_handler(
		$file,
		sprintf(
			/* translators: %s: Destination file path. */
			__( 'The uploaded file could not be moved to %s.' ),
			$error_path
		)
	);
}
}
1039
// Set correct file permissions.
$stat  = stat( dirname( $new_file ) );
$perms = $stat['mode'] & 0000666;
chmod( $new_file, $perms );
1044
// Compute the URL.
$url = $uploads['url'] . "/$filename";
1047
if ( is_multisite() ) {
clean_dirsize_cache( $new_file );
}
1051
/**
* Filters the data array for the uploaded file.
*
* @since 2.1.0
*
* @param array  $upload {
*     Array of upload data.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
* @param string $context The type of upload action. Values include 'upload' or 'sideload'.
*/
return apply_filters(
'wp_handle_upload',
array(
	'file' => $new_file,
	'url'  => $url,
	'type' => $type,
),
'wp_handle_sideload' === $action ? 'sideload' : 'upload'
);
1075}
1076
1077/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_upload'} action.
*
* @since 2.0.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1095function wp_handle_upload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_upload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1104
return _wp_handle_upload( $file, $overrides, $time, $action );
1106}
1107
1108/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_sideload'} action.
*
* @since 2.6.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1126function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_sideload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1135
return _wp_handle_upload( $file, $overrides, $time, $action );
1137}
1138
1139/**
* Downloads a URL to a local temporary file using the WordPress HTTP API.
*
* Please note that the calling function must delete or move the file.
*
* @since 2.5.0
* @since 5.2.0 Signature Verification with SoftFail was added.
* @since 5.9.0 Support for Content-Disposition filename 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 bool   $signature_verification Whether to perform Signature Verification.
*                                       Default false.
* @return string|WP_Error Filename on success, WP_Error on failure.
*/
1155function download_url( $url, $timeout = 300, $signature_verification = false ) {
// WARNING: The file is not automatically deleted, the script must delete or move the file.
if ( ! $url ) {
return new WP_Error( 'http_no_url', __( 'No URL Provided.' ) );
}
1160
$url_path     = parse_url( $url, PHP_URL_PATH );
$url_filename = '';
if ( is_string( $url_path ) && '' !== $url_path ) {
$url_filename = basename( $url_path );
}
1166
$tmpfname = wp_tempnam( $url_filename );
if ( ! $tmpfname ) {
return new WP_Error( 'http_no_file', __( 'Could not create temporary file.' ) );
}
1171
$response = wp_safe_remote_get(
$url,
array(
	'timeout'  => $timeout,
	'stream'   => true,
	'filename' => $tmpfname,
)
);
1180
if ( is_wp_error( $response ) ) {
unlink( $tmpfname );
return $response;
}
1185
$response_code = wp_remote_retrieve_response_code( $response );
1187
if ( 200 !== $response_code ) {
$data = array(
	'code' => $response_code,
);
1192
// Retrieve a sample of the response body for debugging purposes.
$tmpf = fopen( $tmpfname, 'rb' );
1195
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 );
1207
	$data['body'] = fread( $tmpf, $response_size );
	fclose( $tmpf );
}
1211
unlink( $tmpfname );
1213
return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data );
}
1216
$content_disposition = wp_remote_retrieve_header( $response, 'Content-Disposition' );
1218
if ( $content_disposition ) {
$content_disposition = strtolower( $content_disposition );
1221
if ( str_starts_with( $content_disposition, 'attachment; filename=' ) ) {
	$tmpfname_disposition = sanitize_file_name( substr( $content_disposition, 21 ) );
} else {
	$tmpfname_disposition = '';
}
1227
// Potential file name must be valid string.
if ( $tmpfname_disposition && is_string( $tmpfname_disposition )
	&& ( 0 === validate_file( $tmpfname_disposition ) )
) {
	$tmpfname_disposition = dirname( $tmpfname ) . '/' . $tmpfname_disposition;
1233
	if ( rename( $tmpfname, $tmpfname_disposition ) ) {
		$tmpfname = $tmpfname_disposition;
	}
1237
	if ( ( $tmpfname !== $tmpfname_disposition ) && file_exists( $tmpfname_disposition ) ) {
		unlink( $tmpfname_disposition );
	}
}
}
1243
$mime_type = wp_remote_retrieve_header( $response, 'content-type' );
if ( $mime_type && 'tmp' === pathinfo( $tmpfname, PATHINFO_EXTENSION ) ) {
$valid_mime_types = array_flip( get_allowed_mime_types() );
if ( ! empty( $valid_mime_types[ $mime_type ] ) ) {
	$extensions     = explode( '|', $valid_mime_types[ $mime_type ] );
	$new_image_name = substr( $tmpfname, 0, -4 ) . ".{$extensions[0]}";
	if ( 0 === validate_file( $new_image_name ) ) {
		if ( rename( $tmpfname, $new_image_name ) ) {
			$tmpfname = $new_image_name;
		}
1254
		if ( ( $tmpfname !== $new_image_name ) && file_exists( $new_image_name ) ) {
			unlink( $new_image_name );
		}
	}
}
}
1261
$content_md5 = wp_remote_retrieve_header( $response, 'Content-MD5' );
1263
if ( $content_md5 ) {
$md5_check = verify_file_md5( $tmpfname, $content_md5 );
1266
if ( is_wp_error( $md5_check ) ) {
	unlink( $tmpfname );
	return $md5_check;
}
}
1272
// 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 attempted on.
 *
 * @since 5.2.0
 *
 * @param string[] $hostnames List of hostnames.
 */
$signed_hostnames = apply_filters( 'wp_signature_hosts', array( 'wordpress.org', 'downloads.wordpress.org', 's.w.org' ) );
1283
$signature_verification = in_array( parse_url( $url, PHP_URL_HOST ), $signed_hostnames, true );
}
1286
// Perform signature validation if supported.
if ( $signature_verification ) {
$signature = wp_remote_retrieve_header( $response, 'X-Content-Signature' );
1290
if ( ! $signature ) {
	/*
	 * Retrieve signatures from a file if the header wasn't included.
	 * WordPress.org stores signatures at $package_url.sig.
	 */
1296
	$signature_url = false;
1298
	if ( is_string( $url_path ) && ( str_ends_with( $url_path, '.zip' ) || str_ends_with( $url_path, '.tar.gz' ) ) ) {
		$signature_url = str_replace( $url_path, $url_path . '.sig', $url );
	}
1302
	/**
	 * Filters 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 );
1312
	if ( $signature_url ) {
		$signature_request = wp_safe_remote_get(
			$signature_url,
			array(
				'limit_response_size' => 10 * KB_IN_BYTES, // 10KB should be large enough for quite a few signatures.
			)
		);
1320
		if ( ! is_wp_error( $signature_request ) && 200 === wp_remote_retrieve_response_code( $signature_request ) ) {
			$signature = explode( "\n", wp_remote_retrieve_body( $signature_request ) );
		}
	}
}
1326
// Perform the checks.
$signature_verification = verify_file_signature( $tmpfname, $signature, $url_filename );
}
1330
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 );
}
1350
return $signature_verification;
}
1353
return $tmpfname;
1355}
1356
1357/**
* 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 $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5,
*                             or a hex-encoded md5.
* @return bool|WP_Error True on success, false when the MD5 format is unknown/unexpected,
*                       WP_Error on failure.
*/
1368function verify_file_md5( $filename, $expected_md5 ) {
if ( 32 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = pack( 'H*', $expected_md5 );
} elseif ( 24 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = base64_decode( $expected_md5 );
} else {
return false; // Unknown format.
}
1376
$file_md5 = md5_file( $filename, true );
1378
if ( $file_md5 === $expected_raw_md5 ) {
return true;
}
1382
return new WP_Error(
'md5_mismatch',
sprintf(
	/* translators: 1: File checksum, 2: Expected checksum value. */
	__( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ),
	bin2hex( $file_md5 ),
	bin2hex( $expected_raw_md5 )
)
);
1392}
1393
1394/**
* Verifies the contents of a file against its ED25519 signature.
*
* @since 5.2.0
*
* @param string       $filename            The file to validate.
* @param string|array $signatures          A Signature provided for the file.
* @param string|false $filename_for_errors Optional. A friendly filename for errors.
* @return bool|WP_Error True on success, false if verification not attempted,
*                       or WP_Error describing an error condition.
*/
1405function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {
if ( ! $filename_for_errors ) {
$filename_for_errors = wp_basename( $filename );
}
1409
// Check we can process signatures.
if ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) || ! in_array( 'sha384', array_map( 'strtolower', hash_algos() ), true ) ) {
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' )
);
}
1422
// Verify runtime speed of Sodium_Compat is acceptable.
if ( ! extension_loaded( 'sodium' ) && ! ParagonIE_Sodium_Compat::polyfill_is_fast() ) {
$sodium_compat_is_fast = false;
1426
// 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 utilizes during signing verifications.
	 */
	// phpcs:disable WordPress.NamingConventions.ValidVariableName
	$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;
	// phpcs:enable
}
1440
/*
 * 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'                => PHP_VERSION,
			'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' ),
		)
	);
}
}
1462
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,
	)
);
}
1476
$trusted_keys = wp_trusted_keys();
$file_hash    = hash_file( 'sha384', $filename, true );
1479
mbstring_binary_safe_encoding();
1481
$skipped_key       = 0;
$skipped_signature = 0;
1484
foreach ( (array) $signatures as $signature ) {
$signature_raw = base64_decode( $signature );
1487
// Ensure only valid-length signatures are considered.
if ( SODIUM_CRYPTO_SIGN_BYTES !== strlen( $signature_raw ) ) {
	++$skipped_signature;
	continue;
}
1493
foreach ( (array) $trusted_keys as $key ) {
	$key_raw = base64_decode( $key );
1496
	// Only pass valid public keys through.
	if ( SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES !== strlen( $key_raw ) ) {
		++$skipped_key;
		continue;
	}
1502
	if ( sodium_crypto_sign_verify_detached( $signature_raw, $file_hash, $key_raw ) ) {
		reset_mbstring_encoding();
		return true;
	}
}
}
1509
reset_mbstring_encoding();
1511
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'         => PHP_VERSION,
	'sodium'      => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ),
)
);
1531}
1532
1533/**
* Retrieves the list of signing keys trusted by WordPress.
*
* @since 5.2.0
*
* @return string[] Array of base64-encoded signing keys.
*/
1540function wp_trusted_keys() {
$trusted_keys = array();
1542
if ( time() < 1617235200 ) {
// WordPress.org Key #1 - This key is only valid before April 1st, 2021.
$trusted_keys[] = 'fRPyrxb/MvVLbdsYi+OOEv4xc+Eqpsj+kkAS6gNOkI0=';
}
1547
// TODO: Add key #2 with longer expiration.
1549
/**
* Filters the valid signing keys used to verify the contents of files.
*
* @since 5.2.0
*
* @param string[] $trusted_keys The trusted keys that may sign packages.
*/
return apply_filters( 'wp_trusted_keys', $trusted_keys );
1558}
1559
1560/**
* Determines whether the given file is a valid ZIP file.
*
* This function does not test to ensure that a file exists. Non-existent files
* are not valid ZIPs, so those will also return false.
*
* @since 6.4.4
*
* @param string $file Full path to the ZIP file.
* @return bool Whether the file is a valid ZIP file.
*/
1571function wp_zip_file_is_valid( $file ) {
/** This filter is documented in wp-admin/includes/file.php */
if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
$archive          = new ZipArchive();
$archive_is_valid = $archive->open( $file, ZipArchive::CHECKCONS );
if ( true === $archive_is_valid ) {
	$archive->close();
	return true;
}
}
1581
// Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1584
$archive          = new PclZip( $file );
$archive_is_valid = is_array( $archive->properties() );
1587
return $archive_is_valid;
1589}
1590
1591/**
* 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 WordPress filesystem subclass.
*
* @param string $file Full path and filename of ZIP archive.
* @param string $to   Full path on the filesystem to extract archive to.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1609function unzip_file( $file, $to ) {
global $wp_filesystem;
1611
if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) {
return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
}
1615
// Unzip can use a lot of memory, but not this much hopefully.
wp_raise_memory_limit( 'admin' );
1618
$needed_dirs = array();
$to          = trailingslashit( $to );
1621
// Determine any parent directories needed (of the upgrade directory).
if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parents if no children exist.
$path = preg_split( '![/\\\]!', untrailingslashit( $to ) );
for ( $i = count( $path ); $i >= 0; $i-- ) {
	if ( empty( $path[ $i ] ) ) {
		continue;
	}
1629
	$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;
	}
1634
	if ( ! $wp_filesystem->is_dir( $dir ) ) {
		$needed_dirs[] = $dir;
	} else {
		break; // A folder exists, therefore we don't need to check the levels below this.
	}
}
}
1642
/**
* 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 );
if ( true === $result ) {
	return $result;
} elseif ( is_wp_error( $result ) ) {
	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 );
1662}
1663
1664/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1683function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1685
$z = new ZipArchive();
1687
$zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS );
1689
if ( true !== $zopen ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) );
}
1693
$uncompressed_size = 0;
1695
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1698
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1703
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1707
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1712
$uncompressed_size += $info['size'];
1714
$dirname = dirname( $info['name'] );
1716
if ( str_ends_with( $info['name'], '/' ) ) {
	// Directory.
	$needed_dirs[] = $to . untrailingslashit( $info['name'] );
} elseif ( '.' !== $dirname ) {
	// Path to a file.
	$needed_dirs[] = $to . untrailingslashit( $dirname );
}
}
1725
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1728
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1736
if ( $available_space && ( $required_space > $available_space ) ) {
	$z->close();
	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' )
	);
}
}
1746
$needed_dirs = array_unique( $needed_dirs );
1748
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).
	continue;
}
1754
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1758
$parent_folder = dirname( $dir );
1760
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1769
asort( $needed_dirs );
1771
// 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 ) ) {
	$z->close();
	return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), $_dir );
}
}
1780
/**
* Filters archive unzipping to override with a custom process.
*
* @since 6.4.0
*
* @param null|true|WP_Error $result         The result of the override. True on success, otherwise WP Error. Default null.
* @param string             $file           Full path and filename of ZIP archive.
* @param string             $to             Full path on the filesystem to extract archive to.
* @param string[]           $needed_dirs    A full list of required folders that need to be created.
* @param float              $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1793
if ( null !== $pre ) {
// Ensure the ZIP file archive has been closed.
$z->close();
1797
return $pre;
}
1800
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1803
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1808
if ( str_ends_with( $info['name'], '/' ) ) { // Directory.
	continue;
}
1812
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1816
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1821
$contents = $z->getFromIndex( $i );
1823
if ( false === $contents ) {
	$z->close();
	return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] );
}
1828
if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE ) ) {
	$z->close();
	return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] );
}
}
1834
$z->close();
1836
/**
* Filters the result of unzipping an archive.
*
* @since 6.4.0
*
* @param true|WP_Error $result         The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
* @param string        $file           Full path and filename of ZIP archive.
* @param string        $to             Full path on the filesystem the archive was extracted to.
* @param string[]      $needed_dirs    A full list of required folders that were created.
* @param float         $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1849
unset( $needed_dirs );
1851
return $result;
1853}
1854
1855/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1874function _unzip_file_pclzip( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1876
mbstring_binary_safe_encoding();
1878
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1880
$archive = new PclZip( $file );
1882
$archive_files = $archive->extract( PCLZIP_OPT_EXTRACT_AS_STRING );
1884
reset_mbstring_encoding();
1886
// Is the archive valid?
if ( ! is_array( $archive_files ) ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), $archive->errorInfo( true ) );
}
1891
if ( 0 === count( $archive_files ) ) {
return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) );
}
1895
$uncompressed_size = 0;
1897
// Determine any children directories needed (From within the archive).
foreach ( $archive_files as $archive_file ) {
if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1903
$uncompressed_size += $archive_file['size'];
1905
$needed_dirs[] = $to . untrailingslashit( $archive_file['folder'] ? $archive_file['filename'] : dirname( $archive_file['filename'] ) );
}
1908
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1911
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1919
if ( $available_space && ( $required_space > $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' )
	);
}
}
1928
$needed_dirs = array_unique( $needed_dirs );
1930
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).
	continue;
}
1936
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1940
$parent_folder = dirname( $dir );
1942
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1951
asort( $needed_dirs );
1953
// 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_pclzip', __( 'Could not create directory.' ), $_dir );
}
}
1961
/** This filter is documented in src/wp-admin/includes/file.php */
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1964
if ( null !== $pre ) {
return $pre;
}
1968
// Extract the files from the zip.
foreach ( $archive_files as $archive_file ) {
if ( $archive_file['folder'] ) {
	continue;
}

if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1978
// Don't extract invalid files:
if ( 0 !== validate_file( $archive_file['filename'] ) ) {
	continue;
}
1983
if ( ! $wp_filesystem->put_contents( $to . $archive_file['filename'], $archive_file['content'], FS_CHMOD_FILE ) ) {
	return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $archive_file['filename'] );
}
}
1988
/** This action is documented in src/wp-admin/includes/file.php */
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1991
unset( $needed_dirs );
1993
return $result;
1995}
1996
1997/**
* 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 WordPress filesystem subclass.
*
* @param string   $from      Source directory.
* @param string   $to        Destination directory.
* @param string[] $skip_list An array of files/folders to skip copying.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2012function copy_dir( $from, $to, $skip_list = array() ) {
global $wp_filesystem;
2014
$dirlist = $wp_filesystem->dirlist( $from );
2016
if ( false === $dirlist ) {
return new WP_Error( 'dirlist_failed_copy_dir', __( 'Directory listing failed.' ), basename( $from ) );
}
2020
$from = trailingslashit( $from );
$to   = trailingslashit( $to );
2023
if ( ! $wp_filesystem->exists( $to ) && ! $wp_filesystem->mkdir( $to ) ) {
return new WP_Error(
	'mkdir_destination_failed_copy_dir',
	__( 'Could not create the destination directory.' ),
	basename( $to )
);
}
2031
foreach ( (array) $dirlist as $filename => $fileinfo ) {
if ( in_array( $filename, $skip_list, true ) ) {
	continue;
}
2036
if ( 'f' === $fileinfo['type'] ) {
	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 );
2041
		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 );
		}
	}
2046
	wp_opcache_invalidate( $to . $filename );
} elseif ( 'd' === $fileinfo['type'] ) {
	if ( ! $wp_filesystem->is_dir( $to . $filename ) ) {
		if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) {
			return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename );
		}
	}
2054
	// Generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list.
	$sub_skip_list = array();
2057
	foreach ( $skip_list as $skip_item ) {
		if ( str_starts_with( $skip_item, $filename . '/' ) ) {
			$sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
		}
	}
2063
	$result = copy_dir( $from . $filename, $to . $filename, $sub_skip_list );
2065
	if ( is_wp_error( $result ) ) {
		return $result;
	}
}
}
2071
return true;
2073}
2074
2075/**
* Moves a directory from one location to another.
*
* Recursively invalidates OPcache on success.
*
* If the renaming failed, falls back to copy_dir().
*
* Assumes that WP_Filesystem() has already been called and setup.
*
* This function is not designed to merge directories, copy_dir() should be used instead.
*
* @since 6.2.0
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $from      Source directory.
* @param string $to        Destination directory.
* @param bool   $overwrite Optional. Whether to overwrite the destination directory if it exists.
*                          Default false.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2096function move_dir( $from, $to, $overwrite = false ) {
global $wp_filesystem;
2098
if ( trailingslashit( strtolower( $from ) ) === trailingslashit( strtolower( $to ) ) ) {
return new WP_Error( 'source_destination_same_move_dir', __( 'The source and destination are the same.' ) );
}
2102
if ( $wp_filesystem->exists( $to ) ) {
if ( ! $overwrite ) {
	return new WP_Error( 'destination_already_exists_move_dir', __( 'The destination folder already exists.' ), $to );
} elseif ( ! $wp_filesystem->delete( $to, true ) ) {
	// Can't overwrite if the destination couldn't be deleted.
	return new WP_Error( 'destination_not_deleted_move_dir', __( 'The destination directory already exists and could not be removed.' ) );
}
}
2111
if ( $wp_filesystem->move( $from, $to ) ) {
/*
 * When using an environment with shared folders,
 * there is a delay in updating the filesystem's cache.
 *
 * This is a known issue in environments with a VirtualBox provider.
 *
 * A 200ms delay gives time for the filesystem to update its cache,
 * prevents "Operation not permitted", and "No such file or directory" warnings.
 *
 * This delay is used in other projects, including Composer.
 * @link https://github.com/composer/composer/blob/2.5.1/src/Composer/Util/Platform.php#L228-L233
 */
usleep( 200000 );
wp_opcache_invalidate_directory( $to );
2127
return true;
}
2130
// Fall back to a recursive copy.
if ( ! $wp_filesystem->is_dir( $to ) ) {
if ( ! $wp_filesystem->mkdir( $to, FS_CHMOD_DIR ) ) {
	return new WP_Error( 'mkdir_failed_move_dir', __( 'Could not create directory.' ), $to );
}
}
2137
$result = copy_dir( $from, $to, array( basename( $to ) ) );
2139
// Clear the source directory.
if ( true === $result ) {
$wp_filesystem->delete( $from, true );
}
2144
return $result;
2146}
2147
2148/**
* Initializes 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 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 bool|null True on success, false on failure,
*                   null if the filesystem method class file does not exist.
*/
2170function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
global $wp_filesystem;
2172
require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
2174
$method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership );
2176
if ( ! $method ) {
return false;
}
2180
if ( ! class_exists( "WP_Filesystem_$method" ) ) {
2182
/**
 * Filters the path for a specific filesystem method class file.
 *
 * @since 2.6.0
 *
 * @see get_filesystem_method()
 *
 * @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 );
2194
if ( ! file_exists( $abstraction_file ) ) {
	return;
}
2198
require_once $abstraction_file;
}
$method = "WP_Filesystem_$method";
2202
$wp_filesystem = new $method( $args );
2204
/*
* Define the timeouts for the connections. Only available after the constructor is called
* to allow for per-transport overriding of the default.
*/
if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {
define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds.
}
if ( ! defined( 'FS_TIMEOUT' ) ) {
define( 'FS_TIMEOUT', 30 ); // 30 seconds.
}
2215
if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
return false;
}
2219
if ( ! $wp_filesystem->connect() ) {
return false; // There was an error connecting to the server.
}
2223
// Set the permission constants if not already set.
if ( ! defined( 'FS_CHMOD_DIR' ) ) {
define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
}
if ( ! defined( 'FS_CHMOD_FILE' ) ) {
define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
}
2231
return true;
2233}
2234
2235/**
* Determines which method to use for reading, writing, modifying, or deleting
* files on the filesystem.
*
* The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets
* (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2',
* 'ftpext' or 'ftpsockets'.
*
* The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
* or filtering via {@see 'filesystem_method'}.
*
* @link https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#wordpress-upgrade-constants
*
* Plugins may define a custom transport handler, See WP_Filesystem().
*
* @since 2.5.0
*
* @global callable $_wp_filesystem_direct_method
*
* @param array  $args                         Optional. Connection details. Default empty array.
* @param string $context                      Optional. Full path to the directory that is tested
*                                             for being writable. Default empty.
* @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.
*/
2261function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) {
// Please ensure that this is either 'direct', 'ssh2', 'ftpext', or 'ftpsockets'.
$method = defined( 'FS_METHOD' ) ? FS_METHOD : false;
2264
if ( ! $context ) {
$context = WP_CONTENT_DIR;
}
2268
// If the directory doesn't exist (wp-content/languages) then use the parent directory as we'll create it.
if ( WP_LANG_DIR === $context && ! is_dir( $context ) ) {
$context = dirname( $context );
}
2273
$context = trailingslashit( $context );
2275
if ( ! $method ) {
2277
$temp_file_name = $context . 'temp-write-test-' . str_replace( '.', '-', uniqid( '', true ) );
$temp_handle    = @fopen( $temp_file_name, 'w' );
if ( $temp_handle ) {
2281
	// Attempt to determine the file owner of the WordPress files, and that of newly created files.
	$wp_file_owner   = false;
	$temp_file_owner = false;
	if ( function_exists( 'fileowner' ) ) {
		$wp_file_owner   = @fileowner( __FILE__ );
		$temp_file_owner = @fileowner( $temp_file_name );
	}
2289
	if ( false !== $wp_file_owner && $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';
		$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';
		$GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
	}
2306
	fclose( $temp_handle );
	@unlink( $temp_file_name );
}
}
2311
if ( ! $method && isset( $args['connection_type'] ) && 'ssh' === $args['connection_type'] && extension_loaded( 'ssh2' ) ) {
$method = 'ssh2';
}
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.
}
2321
/**
* Filters the filesystem method to use.
*
* @since 2.6.0
*
* @param string $method                       Filesystem method to return.
* @param array  $args                         An array of connection details for the method.
* @param string $context                      Full path to the directory that is tested for being writable.
* @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
return apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership );
2333}
2334
2335/**
* Displays a form to the user to request for their FTP/SSH details in order
* to connect to the filesystem.
*
* All chosen/entered details are saved, excluding the password.
*
* Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
* to specify an alternate FTP/SSH port.
*
* Plugins may override this form by returning true|false via the {@see 'request_filesystem_credentials'} filter.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @global string $pagenow The filename of the current screen.
*
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Optional. Chosen type of filesystem. Default empty.
* @param bool|WP_Error $error                        Optional. Whether the current request has failed
*                                                    to connect, or an error object. Default false.
* @param string        $context                      Optional. Full path to the directory that is tested
*                                                    for being 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|array True if no filesystem credentials are required,
*                    false if they are required but have not been provided,
*                    array of credentials if they are required and have been provided.
*/
2365function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
global $pagenow;
2367
/**
* Filters the filesystem credentials.
*
* Returning anything other than an empty string will effectively short-circuit
* output of the filesystem credentials form, returning that value instead.
*
* A filter should return true if no filesystem credentials are required, false if they are required but have not been
* provided, or an array of credentials if they are required and have been provided.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param mixed         $credentials                  Credentials to return instead. Default empty string.
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Chosen type of filesystem.
* @param bool|WP_Error $error                        Whether the current request has failed to connect,
*                                                    or an error object.
* @param string        $context                      Full path to the directory that is tested for
*                                                    being writable.
* @param array         $extra_fields                 Extra POST fields.
* @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
2391
if ( '' !== $req_cred ) {
return $req_cred;
}
2395
if ( empty( $type ) ) {
$type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
}
2399
if ( 'direct' === $type ) {
return true;
}
2403
if ( is_null( $extra_fields ) ) {
$extra_fields = array( 'version', 'locale' );
}
2407
$credentials = get_option(
'ftp_credentials',
array(
	'hostname' => '',
	'username' => '',
)
);
2415
$submitted_form = wp_unslash( $_POST );
2417
// Verify nonce, or unset submitted form field values on failure.
if ( ! isset( $_POST['_fs_nonce'] ) || ! wp_verify_nonce( $_POST['_fs_nonce'], 'filesystem-credentials' ) ) {
unset(
	$submitted_form['hostname'],
	$submitted_form['username'],
	$submitted_form['password'],
	$submitted_form['public_key'],
	$submitted_form['private_key'],
	$submitted_form['connection_type']
);
}
2429
$ftp_constants = array(
'hostname'    => 'FTP_HOST',
'username'    => 'FTP_USER',
'password'    => 'FTP_PASS',
'public_key'  => 'FTP_PUBKEY',
'private_key' => 'FTP_PRIKEY',
);
2437
/*
* If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string.
* Otherwise, keep it as it previously was (saved details in option).
*/
foreach ( $ftp_constants as $key => $constant ) {
if ( defined( $constant ) ) {
	$credentials[ $key ] = constant( $constant );
} elseif ( ! empty( $submitted_form[ $key ] ) ) {
	$credentials[ $key ] = $submitted_form[ $key ];
} elseif ( ! isset( $credentials[ $key ] ) ) {
	$credentials[ $key ] = '';
}
}
2451
// Sanitize the hostname, some people might pass in odd data.
$credentials['hostname'] = preg_replace( '|\w+://|', '', $credentials['hostname'] ); // Strip any schemes off.
2454
if ( strpos( $credentials['hostname'], ':' ) ) {
list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 );
if ( ! is_numeric( $credentials['port'] ) ) {
	unset( $credentials['port'] );
}
} else {
unset( $credentials['port'] );
}
2463
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.
$credentials['connection_type'] = 'ftps';
} elseif ( ! empty( $submitted_form['connection_type'] ) ) {
$credentials['connection_type'] = $submitted_form['connection_type'];
} elseif ( ! isset( $credentials['connection_type'] ) ) { // All else fails (and it's not defaulted to something else saved), default to FTP.
$credentials['connection_type'] = 'ftp';
}
2473
if ( ! $error
&& ( ! empty( $credentials['hostname'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['password'] )
	|| 'ssh' === $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] )
)
) {
$stored_credentials = $credentials;
2480
if ( ! empty( $stored_credentials['port'] ) ) { // Save port as part of hostname to simplify above code.
	$stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
}
2484
unset(
	$stored_credentials['password'],
	$stored_credentials['port'],
	$stored_credentials['private_key'],
	$stored_credentials['public_key']
);
2491
if ( ! wp_installing() ) {
	update_option( 'ftp_credentials', $stored_credentials, false );
}
2495
return $credentials;
}
2498
$hostname        = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
$username        = isset( $credentials['username'] ) ? $credentials['username'] : '';
$public_key      = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
$private_key     = isset( $credentials['private_key'] ) ? $credentials['private_key'] : '';
$port            = isset( $credentials['port'] ) ? $credentials['port'] : '';
$connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : '';
2505
if ( $error ) {
$error_string = __( '<strong>Error:</strong> Could not connect to the server. Please verify the settings are correct.' );
if ( is_wp_error( $error ) ) {
	$error_string = esc_html( $error->get_error_message() );
}
wp_admin_notice(
	$error_string,
	array(
		'id'                 => 'message',
		'additional_classes' => array( 'error' ),
	)
);
}
2519
$types = array();
if ( extension_loaded( 'ftp' ) || extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) {
$types['ftp'] = __( 'FTP' );
}
if ( extension_loaded( 'ftp' ) ) { // Only this supports FTPS.
$types['ftps'] = __( 'FTPS (SSL)' );
}
if ( extension_loaded( 'ssh2' ) ) {
$types['ssh'] = __( 'SSH2' );
}
2530
/**
* Filters the connection types to output to the filesystem credentials form.
*
* @since 2.9.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param string[]      $types       Types of connections.
* @param array         $credentials Credentials to connect with.
* @param string        $type        Chosen filesystem method.
* @param bool|WP_Error $error       Whether the current request has failed to connect,
*                                   or an error object.
* @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 );
?>
2546<form action="<?php echo esc_url( $form_post ); ?>" method="post">
2547<div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form">
<?php
// Print a H1 heading in the FTP credentials modal dialog, default is a H2.
$heading_tag = 'h2';
if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) {
$heading_tag = 'h1';
}
echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>";
?>
2556<p id="request-filesystem-credentials-desc">
<?php
$label_user = __( 'Username' );
$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.' );
	$label_user = __( 'FTP/SSH Username' );
	$label_pass = __( 'FTP/SSH Password' );
} else {
	_e( 'Please enter your FTP credentials to proceed.' );
	$label_user = __( 'FTP Username' );
	$label_pass = __( 'FTP Password' );
}
echo ' ';
}
_e( 'If you do not remember your credentials, you should contact your web host.' );
2575
$hostname_value = esc_attr( $hostname );
if ( ! empty( $port ) ) {
$hostname_value .= ":$port";
}
2580
$password_value = '';
if ( defined( 'FTP_PASS' ) ) {
$password_value = '*****';
}
?>
2586</p>
2587<label for="hostname">
<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 $hostname_value; ?>"<?php disabled( defined( 'FTP_HOST' ) ); ?> />
2590</label>
2591<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' ) ); ?> />
</label>
2596</div>
2597<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 echo $password_value; ?>"<?php disabled( defined( 'FTP_PASS' ) ); ?> spellcheck="false" />
<?php
if ( ! defined( 'FTP_PASS' ) ) {
	_e( 'This password will not be stored on the server.' );
}
?>
</label>
2607</div>
2608<fieldset>
2609<legend><?php _e( 'Connection Type' ); ?></legend>
<?php
$disabled = disabled( ( defined( 'FTP_SSL' ) && FTP_SSL ) || ( defined( 'FTP_SSH' ) && FTP_SSH ), true, false );
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 ); ?> <?php echo $disabled; ?> />
<?php echo $text; ?>
</label>
<?php
endforeach;
?>
2621</fieldset>
<?php
if ( isset( $types['ssh'] ) ) {
$hidden_class = '';
if ( 'ssh' !== $connection_type ) {
	$hidden_class = ' class="hidden"';
}
?>
2629<fieldset id="ssh-keys"<?php echo $hidden_class; ?>>
2630<legend><?php _e( 'Authentication Keys' ); ?></legend>
2631<label for="public_key">
<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' ) ); ?> />
2634</label>
2635<label for="private_key">
<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' ) ); ?> />
2638</label>
2639<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>
2640</fieldset>
<?php
}
2643
foreach ( (array) $extra_fields as $field ) {
if ( isset( $submitted_form[ $field ] ) ) {
	echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( $submitted_form[ $field ] ) . '" />';
}
}
2649
/*
* Make sure the `submit_button()` function is available during the REST API call
* from WP_Site_Health_Auto_Updates::test_check_wp_filesystem_method().
*/
if ( ! function_exists( 'submit_button' ) ) {
require_once ABSPATH . 'wp-admin/includes/template.php';
}
?>
<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' ), 'primary', 'upgrade', false ); ?>
</p>
2663</div>
2664</form>
<?php
return false;
2667}
2668
2669/**
* Prints the filesystem credentials modal when needed.
*
* @since 4.2.0
*/
2674function wp_print_request_filesystem_credentials_modal() {
$filesystem_method = get_filesystem_method();
2676
ob_start();
$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
ob_end_clean();
2680
$request_filesystem_credentials = ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored );
if ( ! $request_filesystem_credentials ) {
return;
}
?>
<div id="request-filesystem-credentials-dialog" class="notification-dialog-wrap request-filesystem-credentials-dialog">
<div class="notification-dialog-background"></div>
<div class="notification-dialog" role="dialog" aria-labelledby="request-filesystem-credentials-title" tabindex="0">
	<div class="request-filesystem-credentials-dialog-content">
		<?php request_filesystem_credentials( site_url() ); ?>
	</div>
</div>
</div>
<?php
2695}
2696
2697/**
* Attempts to clear the opcode cache for an individual PHP file.
*
* This function can be called safely without having to check the file extension
* or availability of the OPcache extension.
*
* Whether or not invalidation is possible is cached to improve performance.
*
* @since 5.5.0
*
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @param string $filepath Path to the file, including extension, for which the opcode cache is to be cleared.
* @param bool   $force    Invalidate even if the modification time is not newer than the file in cache.
*                         Default false.
* @return bool True if opcache was invalidated for `$filepath`, or there was nothing to invalidate.
*              False if opcache invalidation is not available, or is disabled via filter.
*/
2715function wp_opcache_invalidate( $filepath, $force = false ) {
static $can_invalidate = null;
2717
/*
* Check to see if WordPress is able to run `opcache_invalidate()` or not, and cache the value.
*
* First, check to see if the function is available to call, then if the host has restricted
* the ability to run the function to avoid a PHP warning.
*
* `opcache.restrict_api` can specify the path for files allowed to call `opcache_invalidate()`.
*
* If the host has this set, check whether the path in `opcache.restrict_api` matches
* the beginning of the path of the origin file.
*
* `$_SERVER['SCRIPT_FILENAME']` approximates the origin file's path, but `realpath()`
* is necessary because `SCRIPT_FILENAME` can be a relative path when run from CLI.
*
* For more details, see:
* - https://www.php.net/manual/en/opcache.configuration.php
* - https://www.php.net/manual/en/reserved.variables.server.php
* - https://core.trac.wordpress.org/ticket/36455
*/
if ( null === $can_invalidate
&& function_exists( 'opcache_invalidate' )
&& ( ! ini_get( 'opcache.restrict_api' )
	|| stripos( realpath( $_SERVER['SCRIPT_FILENAME'] ), ini_get( 'opcache.restrict_api' ) ) === 0 )
) {
$can_invalidate = true;
}
2744
// If invalidation is not available, return early.
if ( ! $can_invalidate ) {
return false;
}
2749
// Verify that file to be invalidated has a PHP extension.
if ( '.php' !== strtolower( substr( $filepath, -4 ) ) ) {
return false;
}
2754
/**
* Filters whether to invalidate a file from the opcode cache.
*
* @since 5.5.0
*
* @param bool   $will_invalidate Whether WordPress will invalidate `$filepath`. Default true.
* @param string $filepath        The path to the PHP file to invalidate.
*/
if ( apply_filters( 'wp_opcache_invalidate_file', true, $filepath ) ) {
return opcache_invalidate( $filepath, $force );
}
2766
return false;
2768}
2769
2770/**
* Attempts to clear the opcode cache for a directory of files.
*
* @since 6.2.0
*
* @see wp_opcache_invalidate()
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $dir The path to the directory for which the opcode cache is to be cleared.
*/
2782function wp_opcache_invalidate_directory( $dir ) {
global $wp_filesystem;
2784
if ( ! is_string( $dir ) || '' === trim( $dir ) ) {
if ( WP_DEBUG ) {
	$error_message = sprintf(
		/* translators: %s: The function name. */
		__( '%s expects a non-empty string.' ),
		'<code>wp_opcache_invalidate_directory()</code>'
	);
	wp_trigger_error( '', $error_message );
}
return;
}
2796
$dirlist = $wp_filesystem->dirlist( $dir, false, true );
2798
if ( empty( $dirlist ) ) {
return;
}
2802
/*
* Recursively invalidate opcache of files in a directory.
*
* WP_Filesystem_*::dirlist() returns an array of file and directory information.
*
* This does not include a path to the file or directory.
* To invalidate files within sub-directories, recursion is needed
* to prepend an absolute path containing the sub-directory's name.
*
* @param array  $dirlist Array of file/directory information from WP_Filesystem_Base::dirlist(),
*                        with sub-directories represented as nested arrays.
* @param string $path    Absolute path to the directory.
*/
$invalidate_directory = static function ( $dirlist, $path ) use ( &$invalidate_directory ) {
$path = trailingslashit( $path );
2818
foreach ( $dirlist as $name => $details ) {
	if ( 'f' === $details['type'] ) {
		wp_opcache_invalidate( $path . $name, true );
	} elseif ( is_array( $details['files'] ) && ! empty( $details['files'] ) ) {
		$invalidate_directory( $details['files'], $path . $name );
	}
}
};
2827
$invalidate_directory( $dirlist, $dir );
2829}
2830

After1<?php
2/**
* Filesystem API: Top-level functionality
*
* Functions for reading, writing, modifying, and deleting files on the file system.
* Includes functionality for theme-specific files as well as operations for uploading,
* archiving, and rendering output when necessary.
*
* @package WordPress
* @subpackage Filesystem
* @since 2.3.0
*/
13
14/** The descriptions for theme files. */
15$wp_file_descriptions = array(
'functions.php'         => __( 'Theme Functions' ),
'header.php'            => __( 'Theme Header' ),
'footer.php'            => __( 'Theme Footer' ),
'sidebar.php'           => __( 'Sidebar' ),
'comments.php'          => __( 'Comments' ),
'searchform.php'        => __( 'Search Form' ),
'404.php'               => __( '404 Template' ),
'link.php'              => __( 'Links Template' ),
'theme.json'            => __( 'Theme Styles & Block Settings' ),
// Archives.
'index.php'             => __( 'Main Index Template' ),
'archive.php'           => __( 'Archives' ),
'author.php'            => __( 'Author Template' ),
'taxonomy.php'          => __( 'Taxonomy Template' ),
'category.php'          => __( 'Category Template' ),
'tag.php'               => __( 'Tag Template' ),
'home.php'              => __( 'Posts Page' ),
'search.php'            => __( 'Search Results' ),
'date.php'              => __( 'Date Template' ),
// 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' ),
'application.php'       => __( 'Application Attachment Template' ),
// Embeds.
'embed.php'             => __( 'Embed Template' ),
'embed-404.php'         => __( 'Embed 404 Template' ),
'embed-content.php'     => __( 'Embed Content Template' ),
'header-embed.php'      => __( 'Embed Header Template' ),
'footer-embed.php'      => __( 'Embed Footer Template' ),
// Stylesheets.
'style.css'             => __( 'Stylesheet' ),
'editor-style.css'      => __( 'Visual Editor Stylesheet' ),
'editor-style-rtl.css'  => __( 'Visual Editor RTL Stylesheet' ),
'rtl.css'               => __( 'RTL Stylesheet' ),
// Other.
'my-hacks.php'          => __( 'my-hacks.php (legacy hacks support)' ),
'.htaccess'             => __( '.htaccess (for rewrite rules )' ),
// Deprecated files.
'wp-layout.css'         => __( 'Stylesheet' ),
'wp-comments.php'       => __( 'Comments Template' ),
'wp-comments-popup.php' => __( 'Popup Comments Template' ),
'comments-popup.php'    => __( 'Popup Comments' ),
66);
67
68/**
* Gets the description for standard WordPress theme files.
*
* @since 1.5.0
*
* @global array $wp_file_descriptions Theme file descriptions.
* @global array $allowed_files        List of allowed files.
*
* @param string $file Filesystem path or filename.
* @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist.
*                Appends 'Page Template' to basename of $file if the file is a page template.
*/
80function get_file_description( $file ) {
global $wp_file_descriptions, $allowed_files;
82
$dirname   = pathinfo( $file, PATHINFO_DIRNAME );
$file_path = $allowed_files[ $file ];
85
if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) {
return $wp_file_descriptions[ basename( $file ) ];
} elseif ( file_exists( $file_path ) && is_file( $file_path ) ) {
$template_data = implode( '', file( $file_path ) );
90
if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) {
	/* translators: %s: Template name. */
	return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
}
}
96
return trim( basename( $file ) );
98}
99
100/**
* Gets the absolute filesystem path to the root of the WordPress installation.
*
* @since 1.5.0
*
* @return string Full filesystem path to the root of the WordPress installation.
*/
107function get_home_path() {
$home    = set_url_scheme( get_option( 'home' ), 'http' );
$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );
110
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 ) );
$home_path           = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
$home_path           = trailingslashit( $home_path );
} else {
$home_path = ABSPATH;
}
119
return str_replace( '\\', '/', $home_path );
121}
122
123/**
* Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
*
* The depth of the recursiveness can be controlled by the $levels param.
*
* @since 2.6.0
* @since 4.9.0 Added the `$exclusions` parameter.
* @since 6.3.0 Added the `$include_hidden` parameter.
*
* @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 string[] $exclusions     Optional. List of folders and files to skip.
* @param bool     $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
*                                 Default false.
* @return string[]|false Array of files on success, false on failure.
*/
139function list_files( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false ) {
if ( empty( $folder ) ) {
return false;
}
143
$folder = trailingslashit( $folder );
145
if ( ! $levels ) {
return false;
}
149
$files = array();
151
$dir = @opendir( $folder );
153
if ( $dir ) {
while ( ( $file = readdir( $dir ) ) !== false ) {
	// Skip current and parent folder links.
	if ( in_array( $file, array( '.', '..' ), true ) ) {
		continue;
	}
160
	// Skip hidden and excluded files.
	if ( ( ! $include_hidden && '.' === $file[0] ) || in_array( $file, $exclusions, true ) ) {
		continue;
	}
165
	if ( is_dir( $folder . $file ) ) {
		$files2 = list_files( $folder . $file, $levels - 1, array(), $include_hidden );
		if ( $files2 ) {
			$files = array_merge( $files, $files2 );
		} else {
			$files[] = $folder . $file . '/';
		}
	} else {
		$files[] = $folder . $file;
	}
}
177
closedir( $dir );
}
180
return $files;
182}
183
184/**
* Gets the list of file extensions that are editable in plugins.
*
* @since 4.9.0
*
* @param string $plugin Path to the plugin file relative to the plugins directory.
* @return string[] Array of editable file extensions.
*/
192function wp_get_plugin_file_editable_extensions( $plugin ) {
193
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
228
/**
* Filters the list of file types allowed for editing in the plugin file editor.
*
* @since 2.8.0
* @since 4.9.0 Added the `$plugin` parameter.
*
* @param string[] $default_types An array of editable plugin file extensions.
* @param string   $plugin        Path to the plugin file relative to the plugins directory.
*/
$file_types = (array) apply_filters( 'editable_extensions', $default_types, $plugin );
239
return $file_types;
241}
242
243/**
* Gets the list of file extensions that are editable for a given theme.
*
* @since 4.9.0
*
* @param WP_Theme $theme Theme object.
* @return string[] Array of editable file extensions.
*/
251function wp_get_theme_file_editable_extensions( $theme ) {
252
$default_types = array(
'bash',
'conf',
'css',
'diff',
'htm',
'html',
'http',
'inc',
'include',
'js',
'json',
'jsx',
'less',
'md',
'patch',
'php',
'php3',
'php4',
'php5',
'php7',
'phps',
'phtml',
'sass',
'scss',
'sh',
'sql',
'svg',
'text',
'txt',
'xml',
'yaml',
'yml',
);
287
/**
* Filters the list of file types allowed for editing in the theme file editor.
*
* @since 4.4.0
*
* @param string[] $default_types An array of editable theme file extensions.
* @param WP_Theme $theme         The active theme object.
*/
$file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme );
297
// Ensure that default types are still there.
return array_unique( array_merge( $file_types, $default_types ) );
300}
301
302/**
* Prints file editor templates (for plugins and themes).
*
* @since 4.9.0
*/
307function wp_print_file_editor_templates() {
?>
<script type="text/html" id="tmpl-wp-file-editor-notice">
<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: 1: Line number, 2: File path. */
				__( 'Your PHP code changes were not applied due to an error on line %1$s of file %2$s. Please fix and try saving again.' ),
				'{{ data.line }}',
				'{{ data.file }}'
			);
			?>
		</p>
		<pre>{{ data.message }}</pre>
	<# } else if ( 'file_not_writable' === data.code ) { #>
		<p>
			<?php
			printf(
				/* translators: %s: Documentation URL. */
				__( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ),
				__( 'https://developer.wordpress.org/advanced-administration/server/file-permissions/' )
			);
			?>
		</p>
	<# } else { #>
		<p>{{ data.message || data.code }}</p>
335
		<# if ( 'lint_errors' === data.code ) { #>
			<p>
				<# var elementId = 'el-' + String( Math.random() ); #>
				<input id="{{ elementId }}"  type="checkbox">
				<label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label>
			</p>
		<# } #>
	<# } #>
	<# if ( data.dismissible ) { #>
		<button type="button" class="notice-dismiss"><span class="screen-reader-text">
			<?php
			/* translators: Hidden accessibility text. */
			_e( 'Dismiss' );
			?>
		</span></button>
	<# } #>
</div>
</script>
<?php
355}
356
357/**
* Attempts to edit a file for a theme or plugin.
*
* When editing a PHP file, loopback requests will be made to the admin and the homepage
* to attempt to see if there is a fatal error introduced. If so, the PHP change will be
* reverted.
*
* @since 4.9.0
*
* @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.
*
*     @type string $file       Relative path to file.
*     @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.
*/
378function wp_edit_theme_plugin_file( $args ) {
if ( empty( $args['file'] ) ) {
return new WP_Error( 'missing_file' );
}
382
if ( 0 !== validate_file( $args['file'] ) ) {
return new WP_Error( 'bad_file' );
}
386
if ( ! isset( $args['newcontent'] ) ) {
return new WP_Error( 'missing_content' );
}
390
if ( ! isset( $args['nonce'] ) ) {
return new WP_Error( 'missing_nonce' );
}
394
$file    = $args['file'];
$content = $args['newcontent'];
397
$plugin    = null;
$theme     = null;
$real_file = null;
401
if ( ! empty( $args['plugin'] ) ) {
$plugin = $args['plugin'];
404
if ( ! current_user_can( 'edit_plugins' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit plugins for this site.' ) );
}
408
if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
412
if ( ! array_key_exists( $plugin, get_plugins() ) ) {
	return new WP_Error( 'invalid_plugin' );
}
416
if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {
	return new WP_Error( 'bad_plugin_file_path', __( 'Sorry, that file cannot be edited.' ) );
}
420
$editable_extensions = wp_get_plugin_file_editable_extensions( $plugin );
422
$real_file = WP_PLUGIN_DIR . '/' . $file;
424
$is_active = in_array(
	$plugin,
	(array) get_option( 'active_plugins', array() ),
	true
);
430
} elseif ( ! empty( $args['theme'] ) ) {
$stylesheet = $args['theme'];
433
if ( 0 !== validate_file( $stylesheet ) ) {
	return new WP_Error( 'bad_theme_path' );
}
437
if ( ! current_user_can( 'edit_themes' ) ) {
	return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit templates for this site.' ) );
}
441
$theme = wp_get_theme( $stylesheet );
if ( ! $theme->exists() ) {
	return new WP_Error( 'non_existent_theme', __( 'The requested theme does not exist.' ) );
}
446
if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) {
	return new WP_Error( 'nonce_failure' );
}
450
if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) {
	return new WP_Error(
		'theme_no_stylesheet',
		__( 'The requested theme does not exist.' ) . ' ' . $theme->errors()->get_error_message()
	);
}
457
$editable_extensions = wp_get_theme_file_editable_extensions( $theme );
459
$allowed_files = array();
foreach ( $editable_extensions as $type ) {
	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 );
			$allowed_files['style.css'] = $style_files['style.css'];
			$allowed_files              = array_merge( $allowed_files, $style_files );
			break;
		default:
			$allowed_files = array_merge( $allowed_files, $theme->get_files( $type, -1 ) );
			break;
	}
}
476
// 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.' ) );
}
481
$real_file = $theme->get_stylesheet_directory() . '/' . $file;
483
$is_active = ( get_stylesheet() === $stylesheet || get_template() === $stylesheet );
485
} else {
return new WP_Error( 'missing_theme_or_plugin' );
}
489
// Ensure file is real.
if ( ! is_file( $real_file ) ) {
return new WP_Error( 'file_does_not_exist', __( 'File does not exist! Please double check the name and try again.' ) );
}
494
// Ensure file extension is allowed.
$extension = null;
if ( preg_match( '/\.([^.]+)$/', $real_file, $matches ) ) {
$extension = strtolower( $matches[1] );
if ( ! in_array( $extension, $editable_extensions, true ) ) {
	return new WP_Error( 'illegal_file_type', __( 'Files of this type are not editable.' ) );
}
}
503
$previous_content = file_get_contents( $real_file );
505
if ( ! is_writable( $real_file ) ) {
return new WP_Error( 'file_not_writable' );
}
509
$f = fopen( $real_file, 'w+' );
511
if ( false === $f ) {
return new WP_Error( 'file_not_writable' );
}
515
$written = fwrite( $f, $content );
fclose( $f );
518
if ( false === $written ) {
return new WP_Error( 'unable_to_write', __( 'Unable to write to file.' ) );
}
522
wp_opcache_invalidate( $real_file, true );
524
if ( $is_active && 'php' === $extension ) {
526
$scrape_key   = md5( rand() );
$transient    = 'scrape_key_' . $scrape_key;
$scrape_nonce = (string) rand();
// It shouldn't take more than 60 seconds to make the two loopback requests.
set_transient( $transient, $scrape_nonce, 60 );
532
$cookies       = wp_unslash( $_COOKIE );
$scrape_params = array(
	'wp_scrape_key'   => $scrape_key,
	'wp_scrape_nonce' => $scrape_nonce,
);
$headers       = array(
	'Cache-Control' => 'no-cache',
);
541
/** This filter is documented in wp-includes/class-wp-http-streams.php */
$sslverify = apply_filters( 'https_local_ssl_verify', false );
544
// Include Basic auth in loopback requests.
if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {
	$headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );
}
549
// Make sure PHP process doesn't die before loopback requests complete.
if ( function_exists( 'set_time_limit' ) ) {
	set_time_limit( 5 * MINUTE_IN_SECONDS );
}
554
// Time to wait for loopback requests to finish.
$timeout = 100; // 100 seconds.
557
$needle_start = "###### wp_scraping_result_start:$scrape_key ######";
$needle_end   = "###### wp_scraping_result_end:$scrape_key ######";
560
// 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,
		),
		admin_url( 'theme-editor.php' )
	);
} else {
	$url = admin_url();
}
575
if ( function_exists( 'session_status' ) && PHP_SESSION_ACTIVE === session_status() ) {
	/*
	 * Close any active session to prevent HTTP requests from timing out
	 * when attempting to connect back to the site.
	 */
	session_write_close();
}
583
$url                    = add_query_arg( $scrape_params, $url );
$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
$body                   = wp_remote_retrieve_body( $r );
$scrape_result_position = strpos( $body, $needle_start );
588
$loopback_request_failure = array(
	'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(
	'code' => 'json_parse_error',
);
596
$result = null;
598
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 );
	if ( empty( $result ) ) {
		$result = $json_parse_failure;
	}
}
609
// Try making request to homepage as well to see if visitors have been whitescreened.
if ( true === $result ) {
	$url                    = home_url( '/' );
	$url                    = add_query_arg( $scrape_params, $url );
	$r                      = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );
	$body                   = wp_remote_retrieve_body( $r );
	$scrape_result_position = strpos( $body, $needle_start );
617
	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 );
		if ( empty( $result ) ) {
			$result = $json_parse_failure;
		}
	}
}
629
delete_transient( $transient );
631
if ( true !== $result ) {
	// Roll-back file change.
	file_put_contents( $real_file, $previous_content );
	wp_opcache_invalidate( $real_file, true );
636
	if ( ! isset( $result['message'] ) ) {
		$message = __( 'An error occurred. Please try again later.' );
	} else {
		$message = $result['message'];
		unset( $result['message'] );
	}
643
	return new WP_Error( 'php_error', $message, $result );
}
}
647
if ( $theme instanceof WP_Theme ) {
$theme->cache_delete();
}
651
return true;
653}
654
655
656/**
* Returns a filename of a temporary unique file.
*
* Please note that the calling function must delete or move the file.
*
* The filename is based off the passed parameter or defaults to the current unix timestamp,
* while the directory can either be passed as well, or by leaving it blank, default to a writable
* temporary directory.
*
* @since 2.6.0
*
* @param string $filename Optional. Filename to base the Unique file off. Default empty.
* @param string $dir      Optional. Directory to store the file in. Default empty.
* @return string A writable filename.
*/
671function wp_tempnam( $filename = '', $dir = '' ) {
if ( empty( $dir ) ) {
$dir = get_temp_dir();
}
675
if ( empty( $filename ) || in_array( $filename, array( '.', '/', '\\' ), true ) ) {
$filename = uniqid();
}
679
// 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 );
683
// If the folder is falsey, use its parent directory name instead.
if ( ! $temp_filename ) {
return wp_tempnam( dirname( $filename ), $dir );
}
688
// Suffix some random data to avoid filename conflicts.
$temp_filename .= '-' . wp_generate_password( 6, false );
$temp_filename .= '.tmp';
$temp_filename  = wp_unique_filename( $dir, $temp_filename );
693
/*
* Filesystems typically have a limit of 255 characters for a filename.
*
* If the generated unique filename exceeds this, truncate the initial
* filename and try again.
*
* As it's possible that the truncated filename may exist, producing a
* suffix of "-1" or "-10" which could exceed the limit again, truncate
* it to 252 instead.
*/
$characters_over_limit = strlen( $temp_filename ) - 252;
if ( $characters_over_limit > 0 ) {
$filename = substr( $filename, 0, -$characters_over_limit );
return wp_tempnam( $filename, $dir );
}
709
$temp_filename = $dir . $temp_filename;
711
$fp = @fopen( $temp_filename, 'x' );
713
if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) {
return wp_tempnam( $filename, $dir );
}
717
if ( $fp ) {
fclose( $fp );
}
721
return $temp_filename;
723}
724
725/**
* Makes sure that the file that was requested to be edited is allowed to be edited.
*
* 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[] $allowed_files Optional. Array of allowed files to edit.
*                                `$file` must match an entry exactly.
* @return string|void Returns the file name on success, dies on failure.
*/
737function validate_file_to_edit( $file, $allowed_files = array() ) {
$code = validate_file( $file, $allowed_files );
739
if ( ! $code ) {
return $file;
}
743
switch ( $code ) {
case 1:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
747
	// case 2 :
	// wp_die( __('Sorry, cannot call files with their real path.' ));
750
case 3:
	wp_die( __( 'Sorry, that file cannot be edited.' ) );
}
754}
755
756/**
* Handles PHP uploads in WordPress.
*
* Sanitizes file names, checks extensions for mime type, and moves the file
* to the appropriate directory within the uploads directory.
*
* @access private
* @since 4.0.0
*
* @see wp_handle_upload_error
*
* @param array       $file      {
*     Reference to a single element from `$_FILES`. Call the function once for each uploaded file.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param array|false $overrides {
*     An array of override parameters for this file, or boolean false if none are provided.
*
*     @type callable $upload_error_handler     Function to call when there is an error during the upload process.
*                                              See {@see wp_handle_upload_error()}.
*     @type callable $unique_filename_callback Function to call when determining a unique file name for the file.
*                                              See {@see wp_unique_filename()}.
*     @type string[] $upload_error_strings     The strings that describe the error indicated in
*                                              `$_FILES[{form field}]['error']`.
*     @type bool     $test_form                Whether to test that the `$_POST['action']` parameter is as expected.
*     @type bool     $test_size                Whether to test that the file size is greater than zero bytes.
*     @type bool     $test_type                Whether to test that the mime type of the file is as expected.
*     @type string[] $mimes                    Array of allowed mime types keyed by their file extension regex.
* }
* @param string      $time      Time formatted in 'yyyy/mm'.
* @param string      $action    Expected value for `$_POST['action']`.
* @return array {
*     On success, returns an associative array of file attributes.
*     On failure, returns `$overrides['upload_error_handler']( &$file, $message )`
*     or `array( 'error' => $message )`.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
*/
802function _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 ) {
	return array( 'error' => $message );
}
}
809
/**
* Filters the data for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_prefilter`
*  - `wp_handle_upload_prefilter`
*
* @since 2.9.0 as 'wp_handle_upload_prefilter'.
* @since 4.0.0 Converted to a dynamic hook with `$action`.
*
* @param array $file {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$file = apply_filters( "{$action}_prefilter", $file );
834
/**
* Filters the override parameters for a file before it is uploaded to WordPress.
*
* The dynamic portion of the hook name, `$action`, refers to the post action.
*
* Possible hook names include:
*
*  - `wp_handle_sideload_overrides`
*  - `wp_handle_upload_overrides`
*
* @since 5.7.0
*
* @param array|false $overrides An array of override parameters for this file. Boolean false if none are
*                               provided. See {@see _wp_handle_upload()}.
* @param array       $file      {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
*/
$overrides = apply_filters( "{$action}_overrides", $overrides, $file );
860
// You may define your own function and pass the name in $overrides['upload_error_handler'].
$upload_error_handler = 'wp_handle_upload_error';
if ( isset( $overrides['upload_error_handler'] ) ) {
$upload_error_handler = $overrides['upload_error_handler'];
}
866
// You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully.
if ( isset( $file['error'] ) && ! is_numeric( $file['error'] ) && $file['error'] ) {
return call_user_func_array( $upload_error_handler, array( &$file, $file['error'] ) );
}
871
// Install user overrides. Did we mention that this voids your warranty?
873
// You may define your own function and pass the name in $overrides['unique_filename_callback'].
$unique_filename_callback = null;
if ( isset( $overrides['unique_filename_callback'] ) ) {
$unique_filename_callback = $overrides['unique_filename_callback'];
}
879
/*
* This may not have originally been intended to be overridable,
* but historically has been.
*/
if ( isset( $overrides['upload_error_strings'] ) ) {
$upload_error_strings = $overrides['upload_error_strings'];
} else {
// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].
$upload_error_strings = array(
	false,
	sprintf(
		/* translators: 1: upload_max_filesize, 2: php.ini */
		__( 'The uploaded file exceeds the %1$s directive in %2$s.' ),
		'upload_max_filesize',
		'php.ini'
	),
	sprintf(
		/* translators: %s: MAX_FILE_SIZE */
		__( 'The uploaded file exceeds the %s directive that was specified in the HTML form.' ),
		'MAX_FILE_SIZE'
	),
	__( '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.' ),
);
}
909
// 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;
913
// 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'] : null;
917
// 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.' ) ) );
}
922
// 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'] ] ) );
}
927
// 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.' ) ) );
}
933
$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 ) ) {
if ( is_multisite() ) {
	$error_msg = __( 'File is empty. Please upload something more substantial.' );
} else {
	$error_msg = sprintf(
		/* translators: 1: php.ini, 2: post_max_size, 3: upload_max_filesize */
		__( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your %1$s file or by %2$s being defined as smaller than %3$s in %1$s.' ),
		'php.ini',
		'post_max_size',
		'upload_max_filesize'
	);
}
948
return call_user_func_array( $upload_error_handler, array( &$file, $error_msg ) );
}
951
// 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 );
$ext             = empty( $wp_filetype['ext'] ) ? '' : $wp_filetype['ext'];
$type            = empty( $wp_filetype['type'] ) ? '' : $wp_filetype['type'];
$proper_filename = empty( $wp_filetype['proper_filename'] ) ? '' : $wp_filetype['proper_filename'];
958
// Check to see if wp_check_filetype_and_ext() determined the filename was incorrect.
if ( $proper_filename ) {
	$file['name'] = $proper_filename;
}
963
if ( ( ! $type || ! $ext ) && ! current_user_can( 'unfiltered_upload' ) ) {
	return call_user_func_array( $upload_error_handler, array( &$file, __( 'Sorry, you are not allowed to upload this file type.' ) ) );
}
967
if ( ! $type ) {
	$type = $file['type'];
}
} else {
$type = '';
}
974
/*
* A writable uploads dir will pass this test. Again, there's no point
* overriding this one.
*/
$uploads = wp_upload_dir( $time );
if ( ! ( $uploads && false === $uploads['error'] ) ) {
return call_user_func_array( $upload_error_handler, array( &$file, $uploads['error'] ) );
}
983
$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
985
// Move the file to the uploads dir.
$new_file = $uploads['path'] . "/$filename";
988
/**
* Filters whether to short-circuit moving the uploaded file after passing all checks.
*
* If a non-null value is returned from the filter, moving the file and any related
* error reporting will be completely skipped.
*
* @since 4.9.0
*
* @param mixed    $move_new_file If null (default) move the file after the upload.
* @param array    $file          {
*     Reference to a single element from `$_FILES`.
*
*     @type string $name     The original name of the file on the client machine.
*     @type string $type     The mime type of the file, if the browser provided this information.
*     @type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
*     @type int    $size     The size, in bytes, of the uploaded file.
*     @type int    $error    The error code associated with this file upload.
* }
* @param string   $new_file      Filename of the newly-uploaded file.
* @param string   $type          Mime type of the newly-uploaded file.
*/
$move_new_file = apply_filters( 'pre_move_uploaded_file', null, $file, $new_file, $type );
1011
if ( null === $move_new_file ) {
if ( 'wp_handle_upload' === $action ) {
	$move_new_file = @move_uploaded_file( $file['tmp_name'], $new_file );
} else {
	// Use copy and unlink because rename breaks streams.
	// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
	$move_new_file = @copy( $file['tmp_name'], $new_file );
	unlink( $file['tmp_name'] );
}
1021
if ( false === $move_new_file ) {
	if ( str_starts_with( $uploads['basedir'], ABSPATH ) ) {
		$error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
	} else {
		$error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
	}
1028
	return $upload_error_handler(
		$file,
		sprintf(
			/* translators: %s: Destination file path. */
			__( 'The uploaded file could not be moved to %s.' ),
			$error_path
		)
	);
}
}
1039
// Set correct file permissions.
$stat  = stat( dirname( $new_file ) );
$perms = $stat['mode'] & 0000666;
chmod( $new_file, $perms );
1044
// Compute the URL.
$url = $uploads['url'] . "/$filename";
1047
if ( is_multisite() ) {
clean_dirsize_cache( $new_file );
}
1051
/**
* Filters the data array for the uploaded file.
*
* @since 2.1.0
*
* @param array  $upload {
*     Array of upload data.
*
*     @type string $file Filename of the newly-uploaded file.
*     @type string $url  URL of the newly-uploaded file.
*     @type string $type Mime type of the newly-uploaded file.
* }
* @param string $context The type of upload action. Values include 'upload' or 'sideload'.
*/
return apply_filters(
'wp_handle_upload',
array(
	'file' => $new_file,
	'url'  => $url,
	'type' => $type,
),
'wp_handle_sideload' === $action ? 'sideload' : 'upload'
);
1075}
1076
1077/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_upload'} action.
*
* @since 2.0.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1095function wp_handle_upload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_upload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1104
return _wp_handle_upload( $file, $overrides, $time, $action );
1106}
1107
1108/**
* Wrapper for _wp_handle_upload().
*
* Passes the {@see 'wp_handle_sideload'} action.
*
* @since 2.6.0
*
* @see _wp_handle_upload()
*
* @param array       $file      Reference to a single element of `$_FILES`.
*                               Call the function once for each uploaded file.
*                               See _wp_handle_upload() for accepted values.
* @param array|false $overrides Optional. An associative array of names => values
*                               to override default variables. Default false.
*                               See _wp_handle_upload() for accepted values.
* @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
* @return array See _wp_handle_upload() for return value.
*/
1126function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
/*
*  $_POST['action'] must be set and its value must equal $overrides['action']
*  or this:
*/
$action = 'wp_handle_sideload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
1135
return _wp_handle_upload( $file, $overrides, $time, $action );
1137}
1138
1139/**
* Downloads a URL to a local temporary file using the WordPress HTTP API.
*
* Please note that the calling function must delete or move the file.
*
* @since 2.5.0
* @since 5.2.0 Signature Verification with SoftFail was added.
* @since 5.9.0 Support for Content-Disposition filename 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 bool   $signature_verification Whether to perform Signature Verification.
*                                       Default false.
* @return string|WP_Error Filename on success, WP_Error on failure.
*/
1155function download_url( $url, $timeout = 300, $signature_verification = false ) {
// WARNING: The file is not automatically deleted, the script must delete or move the file.
if ( ! $url ) {
return new WP_Error( 'http_no_url', __( 'No URL Provided.' ) );
}
1160
$url_path     = parse_url( $url, PHP_URL_PATH );
$url_filename = '';
if ( is_string( $url_path ) && '' !== $url_path ) {
$url_filename = basename( $url_path );
}
1166
$tmpfname = wp_tempnam( $url_filename );
if ( ! $tmpfname ) {
return new WP_Error( 'http_no_file', __( 'Could not create temporary file.' ) );
}
1171
$response = wp_safe_remote_get(
$url,
array(
	'timeout'  => $timeout,
	'stream'   => true,
	'filename' => $tmpfname,
)
);
1180
if ( is_wp_error( $response ) ) {
unlink( $tmpfname );
return $response;
}
1185
$response_code = wp_remote_retrieve_response_code( $response );
1187
if ( 200 !== $response_code ) {
$data = array(
	'code' => $response_code,
);
1192
// Retrieve a sample of the response body for debugging purposes.
$tmpf = fopen( $tmpfname, 'rb' );
1195
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 );
1207
	$data['body'] = fread( $tmpf, $response_size );
	fclose( $tmpf );
}
1211
unlink( $tmpfname );
1213
return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data );
}
1216
$content_disposition = wp_remote_retrieve_header( $response, 'Content-Disposition' );
1218
if ( $content_disposition ) {
$content_disposition = strtolower( $content_disposition );
1221
if ( str_starts_with( $content_disposition, 'attachment; filename=' ) ) {
	$tmpfname_disposition = sanitize_file_name( substr( $content_disposition, 21 ) );
} else {
	$tmpfname_disposition = '';
}
1227
// Potential file name must be valid string.
if ( $tmpfname_disposition && is_string( $tmpfname_disposition )
	&& ( 0 === validate_file( $tmpfname_disposition ) )
) {
	$tmpfname_disposition = dirname( $tmpfname ) . '/' . $tmpfname_disposition;
1233
	if ( rename( $tmpfname, $tmpfname_disposition ) ) {
		$tmpfname = $tmpfname_disposition;
	}
1237
	if ( ( $tmpfname !== $tmpfname_disposition ) && file_exists( $tmpfname_disposition ) ) {
		unlink( $tmpfname_disposition );
	}
}
}
1243
$mime_type = wp_remote_retrieve_header( $response, 'content-type' );
if ( $mime_type && 'tmp' === pathinfo( $tmpfname, PATHINFO_EXTENSION ) ) {
$valid_mime_types = array_flip( get_allowed_mime_types() );
if ( ! empty( $valid_mime_types[ $mime_type ] ) ) {
	$extensions     = explode( '|', $valid_mime_types[ $mime_type ] );
	$new_image_name = substr( $tmpfname, 0, -4 ) . ".{$extensions[0]}";
	if ( 0 === validate_file( $new_image_name ) ) {
		if ( rename( $tmpfname, $new_image_name ) ) {
			$tmpfname = $new_image_name;
		}
1254
		if ( ( $tmpfname !== $new_image_name ) && file_exists( $new_image_name ) ) {
			unlink( $new_image_name );
		}
	}
}
}
1261
$content_md5 = wp_remote_retrieve_header( $response, 'Content-MD5' );
1263
if ( $content_md5 ) {
$md5_check = verify_file_md5( $tmpfname, $content_md5 );
1266
if ( is_wp_error( $md5_check ) ) {
	unlink( $tmpfname );
	return $md5_check;
}
}
1272
// 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 attempted on.
 *
 * @since 5.2.0
 *
 * @param string[] $hostnames List of hostnames.
 */
$signed_hostnames = apply_filters( 'wp_signature_hosts', array( 'wordpress.org', 'downloads.wordpress.org', 's.w.org' ) );
1283
$signature_verification = in_array( parse_url( $url, PHP_URL_HOST ), $signed_hostnames, true );
}
1286
// Perform signature validation if supported.
if ( $signature_verification ) {
$signature = wp_remote_retrieve_header( $response, 'X-Content-Signature' );
1290
if ( ! $signature ) {
	/*
	 * Retrieve signatures from a file if the header wasn't included.
	 * WordPress.org stores signatures at $package_url.sig.
	 */
1296
	$signature_url = false;
1298
	if ( is_string( $url_path ) && ( str_ends_with( $url_path, '.zip' ) || str_ends_with( $url_path, '.tar.gz' ) ) ) {
		$signature_url = str_replace( $url_path, $url_path . '.sig', $url );
	}
1302
	/**
	 * Filters 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 );
1312
	if ( $signature_url ) {
		$signature_request = wp_safe_remote_get(
			$signature_url,
			array(
				'limit_response_size' => 10 * KB_IN_BYTES, // 10KB should be large enough for quite a few signatures.
			)
		);
1320
		if ( ! is_wp_error( $signature_request ) && 200 === wp_remote_retrieve_response_code( $signature_request ) ) {
			$signature = explode( "\n", wp_remote_retrieve_body( $signature_request ) );
		}
	}
}
1326
// Perform the checks.
$signature_verification = verify_file_signature( $tmpfname, $signature, $url_filename );
}
1330
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 );
}
1350
return $signature_verification;
}
1353
return $tmpfname;
1355}
1356
1357/**
* 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 $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5,
*                             or a hex-encoded md5.
* @return bool|WP_Error True on success, false when the MD5 format is unknown/unexpected,
*                       WP_Error on failure.
*/
1368function verify_file_md5( $filename, $expected_md5 ) {
if ( 32 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = pack( 'H*', $expected_md5 );
} elseif ( 24 === strlen( $expected_md5 ) ) {
$expected_raw_md5 = base64_decode( $expected_md5 );
} else {
return false; // Unknown format.
}
1376
$file_md5 = md5_file( $filename, true );
1378
if ( $file_md5 === $expected_raw_md5 ) {
return true;
}
1382
return new WP_Error(
'md5_mismatch',
sprintf(
	/* translators: 1: File checksum, 2: Expected checksum value. */
	__( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ),
	bin2hex( $file_md5 ),
	bin2hex( $expected_raw_md5 )
)
);
1392}
1393
1394/**
* Verifies the contents of a file against its ED25519 signature.
*
* @since 5.2.0
*
* @param string       $filename            The file to validate.
* @param string|array $signatures          A Signature provided for the file.
* @param string|false $filename_for_errors Optional. A friendly filename for errors.
* @return bool|WP_Error True on success, false if verification not attempted,
*                       or WP_Error describing an error condition.
*/
1405function verify_file_signature( $filename, $signatures, $filename_for_errors = false ) {
if ( ! $filename_for_errors ) {
$filename_for_errors = wp_basename( $filename );
}
1409
// Check we can process signatures.
if ( ! function_exists( 'sodium_crypto_sign_verify_detached' ) || ! in_array( 'sha384', array_map( 'strtolower', hash_algos() ), true ) ) {
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' )
);
}
1422
// Verify runtime speed of Sodium_Compat is acceptable.
if ( ! extension_loaded( 'sodium' ) && ! ParagonIE_Sodium_Compat::polyfill_is_fast() ) {
$sodium_compat_is_fast = false;
1426
// 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 utilizes during signing verifications.
	 */
	// phpcs:disable WordPress.NamingConventions.ValidVariableName
	$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;
	// phpcs:enable
}
1440
/*
 * 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'                => PHP_VERSION,
			'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' ),
		)
	);
}
}
1462
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,
	)
);
}
1476
$trusted_keys = wp_trusted_keys();
$file_hash    = hash_file( 'sha384', $filename, true );
1479
mbstring_binary_safe_encoding();
1481
$skipped_key       = 0;
$skipped_signature = 0;
1484
foreach ( (array) $signatures as $signature ) {
$signature_raw = base64_decode( $signature );
1487
// Ensure only valid-length signatures are considered.
if ( SODIUM_CRYPTO_SIGN_BYTES !== strlen( $signature_raw ) ) {
	++$skipped_signature;
	continue;
}
1493
foreach ( (array) $trusted_keys as $key ) {
	$key_raw = base64_decode( $key );
1496
	// Only pass valid public keys through.
	if ( SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES !== strlen( $key_raw ) ) {
		++$skipped_key;
		continue;
	}
1502
	if ( sodium_crypto_sign_verify_detached( $signature_raw, $file_hash, $key_raw ) ) {
		reset_mbstring_encoding();
		return true;
	}
}
}
1509
reset_mbstring_encoding();
1511
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'         => PHP_VERSION,
	'sodium'      => defined( 'SODIUM_LIBRARY_VERSION' ) ? SODIUM_LIBRARY_VERSION : ( defined( 'ParagonIE_Sodium_Compat::VERSION_STRING' ) ? ParagonIE_Sodium_Compat::VERSION_STRING : false ),
)
);
1531}
1532
1533/**
* Retrieves the list of signing keys trusted by WordPress.
*
* @since 5.2.0
*
* @return string[] Array of base64-encoded signing keys.
*/
1540function wp_trusted_keys() {
$trusted_keys = array();
1542
if ( time() < 1617235200 ) {
// WordPress.org Key #1 - This key is only valid before April 1st, 2021.
$trusted_keys[] = 'fRPyrxb/MvVLbdsYi+OOEv4xc+Eqpsj+kkAS6gNOkI0=';
}
1547
// TODO: Add key #2 with longer expiration.
1549
/**
* Filters the valid signing keys used to verify the contents of files.
*
* @since 5.2.0
*
* @param string[] $trusted_keys The trusted keys that may sign packages.
*/
return apply_filters( 'wp_trusted_keys', $trusted_keys );
1558}
1559
1560/**
* Determines whether the given file is a valid ZIP file.
*
* This function does not test to ensure that a file exists. Non-existent files
* are not valid ZIPs, so those will also return false.
*
* @since 6.4.4
*
* @param string $file Full path to the ZIP file.
* @return bool Whether the file is a valid ZIP file.
*/
1571function wp_zip_file_is_valid( $file ) {
/** This filter is documented in wp-admin/includes/file.php */
if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
$archive          = new ZipArchive();
$archive_is_valid = $archive->open( $file, ZipArchive::CHECKCONS );
if ( true === $archive_is_valid ) {
	$archive->close();
	return true;
}
}
1581
// Fall through to PclZip if ZipArchive is not available, or encountered an error opening the file.
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1584
$archive          = new PclZip( $file );
$archive_is_valid = is_array( $archive->properties() );
1587
return $archive_is_valid;
1589}
1590
1591/**
* 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 WordPress filesystem subclass.
*
* @param string $file Full path and filename of ZIP archive.
* @param string $to   Full path on the filesystem to extract archive to.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1609function unzip_file( $file, $to ) {
global $wp_filesystem;
1611
if ( ! $wp_filesystem || ! is_object( $wp_filesystem ) ) {
return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
}
1615
// Unzip can use a lot of memory, but not this much hopefully.
wp_raise_memory_limit( 'admin' );
1618
$needed_dirs = array();
$to          = trailingslashit( $to );
1621
// Determine any parent directories needed (of the upgrade directory).
if ( ! $wp_filesystem->is_dir( $to ) ) { // Only do parents if no children exist.
$path = preg_split( '![/\\\]!', untrailingslashit( $to ) );
for ( $i = count( $path ); $i >= 0; $i-- ) {
	if ( empty( $path[ $i ] ) ) {
		continue;
	}
1629
	$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;
	}
1634
	if ( ! $wp_filesystem->is_dir( $dir ) ) {
		$needed_dirs[] = $dir;
	} else {
		break; // A folder exists, therefore we don't need to check the levels below this.
	}
}
}
1642
/**
* 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 );
if ( true === $result ) {
	return $result;
} elseif ( is_wp_error( $result ) ) {
	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 );
1662}
1663
1664/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1683function _unzip_file_ziparchive( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1685
$z = new ZipArchive();
1687
$zopen = $z->open( $file, ZIPARCHIVE::CHECKCONS );
1689
if ( true !== $zopen ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), array( 'ziparchive_error' => $zopen ) );
}
1693
$uncompressed_size = 0;
1695
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1698
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1703
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1707
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1712
$uncompressed_size += $info['size'];
1714
$dirname = dirname( $info['name'] );
1716
if ( str_ends_with( $info['name'], '/' ) ) {
	// Directory.
	$needed_dirs[] = $to . untrailingslashit( $info['name'] );
} elseif ( '.' !== $dirname ) {
	// Path to a file.
	$needed_dirs[] = $to . untrailingslashit( $dirname );
}
}
1725
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1728
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1736
if ( $available_space && ( $required_space > $available_space ) ) {
	$z->close();
	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' )
	);
}
}
1746
$needed_dirs = array_unique( $needed_dirs );
1748
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).
	continue;
}
1754
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1758
$parent_folder = dirname( $dir );
1760
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1769
asort( $needed_dirs );
1771
// 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 ) ) {
	$z->close();
	return new WP_Error( 'mkdir_failed_ziparchive', __( 'Could not create directory.' ), $_dir );
}
}
1780
/**
* Filters archive unzipping to override with a custom process.
*
* @since 6.4.0
*
* @param null|true|WP_Error $result         The result of the override. True on success, otherwise WP Error. Default null.
* @param string             $file           Full path and filename of ZIP archive.
* @param string             $to             Full path on the filesystem to extract archive to.
* @param string[]           $needed_dirs    A full list of required folders that need to be created.
* @param float              $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1793
if ( null !== $pre ) {
// Ensure the ZIP file archive has been closed.
$z->close();
1797
return $pre;
}
1800
for ( $i = 0; $i < $z->numFiles; $i++ ) {
$info = $z->statIndex( $i );
1803
if ( ! $info ) {
	$z->close();
	return new WP_Error( 'stat_failed_ziparchive', __( 'Could not retrieve file from archive.' ) );
}
1808
if ( str_ends_with( $info['name'], '/' ) ) { // Directory.
	continue;
}
1812
if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1816
// Don't extract invalid files:
if ( 0 !== validate_file( $info['name'] ) ) {
	continue;
}
1821
$contents = $z->getFromIndex( $i );
1823
if ( false === $contents ) {
	$z->close();
	return new WP_Error( 'extract_failed_ziparchive', __( 'Could not extract file from archive.' ), $info['name'] );
}
1828
if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE ) ) {
	$z->close();
	return new WP_Error( 'copy_failed_ziparchive', __( 'Could not copy file.' ), $info['name'] );
}
}
1834
$z->close();
1836
/**
* Filters the result of unzipping an archive.
*
* @since 6.4.0
*
* @param true|WP_Error $result         The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
* @param string        $file           Full path and filename of ZIP archive.
* @param string        $to             Full path on the filesystem the archive was extracted to.
* @param string[]      $needed_dirs    A full list of required folders that were created.
* @param float         $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
*/
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1849
unset( $needed_dirs );
1851
return $result;
1853}
1854
1855/**
* 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
* @access private
*
* @see unzip_file()
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string   $file        Full path and filename of ZIP archive.
* @param string   $to          Full path on the filesystem to extract archive to.
* @param string[] $needed_dirs A partial list of required folders needed to be created.
* @return true|WP_Error True on success, WP_Error on failure.
*/
1874function _unzip_file_pclzip( $file, $to, $needed_dirs = array() ) {
global $wp_filesystem;
1876
mbstring_binary_safe_encoding();
1878
require_once ABSPATH . 'wp-admin/includes/class-pclzip.php';
1880
$archive = new PclZip( $file );
1882
$archive_files = $archive->extract( PCLZIP_OPT_EXTRACT_AS_STRING );
1884
reset_mbstring_encoding();
1886
// Is the archive valid?
if ( ! is_array( $archive_files ) ) {
return new WP_Error( 'incompatible_archive', __( 'Incompatible Archive.' ), $archive->errorInfo( true ) );
}
1891
if ( 0 === count( $archive_files ) ) {
return new WP_Error( 'empty_archive_pclzip', __( 'Empty archive.' ) );
}
1895
$uncompressed_size = 0;
1897
// Determine any children directories needed (From within the archive).
foreach ( $archive_files as $archive_file ) {
if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
	continue;
}
1903
$uncompressed_size += $archive_file['size'];
1905
$needed_dirs[] = $to . untrailingslashit( $archive_file['folder'] ? $archive_file['filename'] : dirname( $archive_file['filename'] ) );
}
1908
// Enough space to unzip the file and copy its contents, with a 10% buffer.
$required_space = $uncompressed_size * 2.1;
1911
/*
* 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 = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
1919
if ( $available_space && ( $required_space > $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' )
	);
}
}
1928
$needed_dirs = array_unique( $needed_dirs );
1930
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).
	continue;
}
1936
if ( ! str_contains( $dir, $to ) ) { // If the directory is not within the working directory, skip it.
	continue;
}
1940
$parent_folder = dirname( $dir );
1942
while ( ! empty( $parent_folder )
	&& untrailingslashit( $to ) !== $parent_folder
	&& ! in_array( $parent_folder, $needed_dirs, true )
) {
	$needed_dirs[] = $parent_folder;
	$parent_folder = dirname( $parent_folder );
}
}
1951
asort( $needed_dirs );
1953
// 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_pclzip', __( 'Could not create directory.' ), $_dir );
}
}
1961
/** This filter is documented in src/wp-admin/includes/file.php */
$pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
1964
if ( null !== $pre ) {
return $pre;
}
1968
// Extract the files from the zip.
foreach ( $archive_files as $archive_file ) {
if ( $archive_file['folder'] ) {
	continue;
}
1974
if ( str_starts_with( $archive_file['filename'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
	continue;
}
1978
// Don't extract invalid files:
if ( 0 !== validate_file( $archive_file['filename'] ) ) {
	continue;
}
1983
if ( ! $wp_filesystem->put_contents( $to . $archive_file['filename'], $archive_file['content'], FS_CHMOD_FILE ) ) {
	return new WP_Error( 'copy_failed_pclzip', __( 'Could not copy file.' ), $archive_file['filename'] );
}
}
1988
/** This action is documented in src/wp-admin/includes/file.php */
$result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
1991
unset( $needed_dirs );
1993
return $result;
1995}
1996
1997/**
* 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 WordPress filesystem subclass.
*
* @param string   $from      Source directory.
* @param string   $to        Destination directory.
* @param string[] $skip_list An array of files/folders to skip copying.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2012function copy_dir( $from, $to, $skip_list = array() ) {
global $wp_filesystem;
2014
$dirlist = $wp_filesystem->dirlist( $from );
2016
if ( false === $dirlist ) {
return new WP_Error( 'dirlist_failed_copy_dir', __( 'Directory listing failed.' ), basename( $from ) );
}
2020
$from = trailingslashit( $from );
$to   = trailingslashit( $to );
2023
if ( ! $wp_filesystem->exists( $to ) && ! $wp_filesystem->mkdir( $to ) ) {
return new WP_Error(
	'mkdir_destination_failed_copy_dir',
	__( 'Could not create the destination directory.' ),
	basename( $to )
);
}
2031
foreach ( (array) $dirlist as $filename => $fileinfo ) {
if ( in_array( $filename, $skip_list, true ) ) {
	continue;
}
2036
if ( 'f' === $fileinfo['type'] ) {
	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 );
2041
		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 );
		}
	}
2046
	wp_opcache_invalidate( $to . $filename );
} elseif ( 'd' === $fileinfo['type'] ) {
	if ( ! $wp_filesystem->is_dir( $to . $filename ) ) {
		if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) {
			return new WP_Error( 'mkdir_failed_copy_dir', __( 'Could not create directory.' ), $to . $filename );
		}
	}
2054
	// Generate the $sub_skip_list for the subdirectory as a sub-set of the existing $skip_list.
	$sub_skip_list = array();
2057
	foreach ( $skip_list as $skip_item ) {
		if ( str_starts_with( $skip_item, $filename . '/' ) ) {
			$sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
		}
	}
2063
	$result = copy_dir( $from . $filename, $to . $filename, $sub_skip_list );
2065
	if ( is_wp_error( $result ) ) {
		return $result;
	}
}
}
2071
return true;
2073}
2074
2075/**
* Moves a directory from one location to another.
*
* Recursively invalidates OPcache on success.
*
* If the renaming failed, falls back to copy_dir().
*
* Assumes that WP_Filesystem() has already been called and setup.
*
* This function is not designed to merge directories, copy_dir() should be used instead.
*
* @since 6.2.0
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $from      Source directory.
* @param string $to        Destination directory.
* @param bool   $overwrite Optional. Whether to overwrite the destination directory if it exists.
*                          Default false.
* @return true|WP_Error True on success, WP_Error on failure.
*/
2096function move_dir( $from, $to, $overwrite = false ) {
global $wp_filesystem;
2098
if ( trailingslashit( strtolower( $from ) ) === trailingslashit( strtolower( $to ) ) ) {
return new WP_Error( 'source_destination_same_move_dir', __( 'The source and destination are the same.' ) );
}
2102
if ( $wp_filesystem->exists( $to ) ) {
if ( ! $overwrite ) {
	return new WP_Error( 'destination_already_exists_move_dir', __( 'The destination folder already exists.' ), $to );
} elseif ( ! $wp_filesystem->delete( $to, true ) ) {
	// Can't overwrite if the destination couldn't be deleted.
	return new WP_Error( 'destination_not_deleted_move_dir', __( 'The destination directory already exists and could not be removed.' ) );
}
}
2111
if ( $wp_filesystem->move( $from, $to ) ) {
/*
 * When using an environment with shared folders,
 * there is a delay in updating the filesystem's cache.
 *
 * This is a known issue in environments with a VirtualBox provider.
 *
 * A 200ms delay gives time for the filesystem to update its cache,
 * prevents "Operation not permitted", and "No such file or directory" warnings.
 *
 * This delay is used in other projects, including Composer.
 * @link https://github.com/composer/composer/blob/2.5.1/src/Composer/Util/Platform.php#L228-L233
 */
usleep( 200000 );
wp_opcache_invalidate_directory( $to );
2127
return true;
}
2130
// Fall back to a recursive copy.
if ( ! $wp_filesystem->is_dir( $to ) ) {
if ( ! $wp_filesystem->mkdir( $to, FS_CHMOD_DIR ) ) {
	return new WP_Error( 'mkdir_failed_move_dir', __( 'Could not create directory.' ), $to );
}
}
2137
$result = copy_dir( $from, $to, array( basename( $to ) ) );
2139
// Clear the source directory.
if ( true === $result ) {
$wp_filesystem->delete( $from, true );
}
2144
return $result;
2146}
2147
2148/**
* Initializes 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 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 bool|null True on success, false on failure,
*                   null if the filesystem method class file does not exist.
*/
2170function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
global $wp_filesystem;
2172
require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';
2174
$method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership );
2176
if ( ! $method ) {
return false;
}
2180
if ( ! class_exists( "WP_Filesystem_$method" ) ) {
2182
/**
 * Filters the path for a specific filesystem method class file.
 *
 * @since 2.6.0
 *
 * @see get_filesystem_method()
 *
 * @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 );
2194
if ( ! file_exists( $abstraction_file ) ) {
	return;
}
2198
require_once $abstraction_file;
}
$method = "WP_Filesystem_$method";
2202
$wp_filesystem = new $method( $args );
2204
/*
* Define the timeouts for the connections. Only available after the constructor is called
* to allow for per-transport overriding of the default.
*/
if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {
define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds.
}
if ( ! defined( 'FS_TIMEOUT' ) ) {
define( 'FS_TIMEOUT', 30 ); // 30 seconds.
}
2215
if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
return false;
}
2219
if ( ! $wp_filesystem->connect() ) {
return false; // There was an error connecting to the server.
}
2223
// Set the permission constants if not already set.
if ( ! defined( 'FS_CHMOD_DIR' ) ) {
define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );
}
if ( ! defined( 'FS_CHMOD_FILE' ) ) {
define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );
}
2231
return true;
2233}
2234
2235/**
* Determines which method to use for reading, writing, modifying, or deleting
* files on the filesystem.
*
* The priority of the transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets
* (Via Sockets class, or `fsockopen()`). Valid values for these are: 'direct', 'ssh2',
* 'ftpext' or 'ftpsockets'.
*
* The return value can be overridden by defining the `FS_METHOD` constant in `wp-config.php`,
* or filtering via {@see 'filesystem_method'}.
*
* @link https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#wordpress-upgrade-constants
*
* Plugins may define a custom transport handler, See WP_Filesystem().
*
* @since 2.5.0
*
* @global callable $_wp_filesystem_direct_method
*
* @param array  $args                         Optional. Connection details. Default empty array.
* @param string $context                      Optional. Full path to the directory that is tested
*                                             for being writable. Default empty.
* @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.
*/
2261function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) {
// Please ensure that this is either 'direct', 'ssh2', 'ftpext', or 'ftpsockets'.
$method = defined( 'FS_METHOD' ) ? FS_METHOD : false;
2264
if ( ! $context ) {
$context = WP_CONTENT_DIR;
}
2268
// If the directory doesn't exist (wp-content/languages) then use the parent directory as we'll create it.
if ( WP_LANG_DIR === $context && ! is_dir( $context ) ) {
$context = dirname( $context );
}
2273
$context = trailingslashit( $context );
2275
if ( ! $method ) {
2277
$temp_file_name = $context . 'temp-write-test-' . str_replace( '.', '-', uniqid( '', true ) );
$temp_handle    = @fopen( $temp_file_name, 'w' );
if ( $temp_handle ) {
2281
	// Attempt to determine the file owner of the WordPress files, and that of newly created files.
	$wp_file_owner   = false;
	$temp_file_owner = false;
	if ( function_exists( 'fileowner' ) ) {
		$wp_file_owner   = @fileowner( __FILE__ );
		$temp_file_owner = @fileowner( $temp_file_name );
	}
2289
	if ( false !== $wp_file_owner && $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';
		$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';
		$GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
	}
2306
	fclose( $temp_handle );
	@unlink( $temp_file_name );
}
}
2311
if ( ! $method && isset( $args['connection_type'] ) && 'ssh' === $args['connection_type'] && extension_loaded( 'ssh2' ) ) {
$method = 'ssh2';
}
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.
}
2321
/**
* Filters the filesystem method to use.
*
* @since 2.6.0
*
* @param string $method                       Filesystem method to return.
* @param array  $args                         An array of connection details for the method.
* @param string $context                      Full path to the directory that is tested for being writable.
* @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
return apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership );
2333}
2334
2335/**
* Displays a form to the user to request for their FTP/SSH details in order
* to connect to the filesystem.
*
* All chosen/entered details are saved, excluding the password.
*
* Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
* to specify an alternate FTP/SSH port.
*
* Plugins may override this form by returning true|false via the {@see 'request_filesystem_credentials'} filter.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @global string $pagenow The filename of the current screen.
*
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Optional. Chosen type of filesystem. Default empty.
* @param bool|WP_Error $error                        Optional. Whether the current request has failed
*                                                    to connect, or an error object. Default false.
* @param string        $context                      Optional. Full path to the directory that is tested
*                                                    for being 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|array True if no filesystem credentials are required,
*                    false if they are required but have not been provided,
*                    array of credentials if they are required and have been provided.
*/
2365function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
global $pagenow;
2367
/**
* Filters the filesystem credentials.
*
* Returning anything other than an empty string will effectively short-circuit
* output of the filesystem credentials form, returning that value instead.
*
* A filter should return true if no filesystem credentials are required, false if they are required but have not been
* provided, or an array of credentials if they are required and have been provided.
*
* @since 2.5.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param mixed         $credentials                  Credentials to return instead. Default empty string.
* @param string        $form_post                    The URL to post the form to.
* @param string        $type                         Chosen type of filesystem.
* @param bool|WP_Error $error                        Whether the current request has failed to connect,
*                                                    or an error object.
* @param string        $context                      Full path to the directory that is tested for
*                                                    being writable.
* @param array         $extra_fields                 Extra POST fields.
* @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
*/
$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
2391
if ( '' !== $req_cred ) {
return $req_cred;
}
2395
if ( empty( $type ) ) {
$type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
}
2399
if ( 'direct' === $type ) {
return true;
}
2403
if ( is_null( $extra_fields ) ) {
$extra_fields = array( 'version', 'locale' );
}
2407
$credentials = get_option(
'ftp_credentials',
array(
	'hostname' => '',
	'username' => '',
)
);
2415
$submitted_form = wp_unslash( $_POST );
2417
// Verify nonce, or unset submitted form field values on failure.
if ( ! isset( $_POST['_fs_nonce'] ) || ! wp_verify_nonce( $_POST['_fs_nonce'], 'filesystem-credentials' ) ) {
unset(
	$submitted_form['hostname'],
	$submitted_form['username'],
	$submitted_form['password'],
	$submitted_form['public_key'],
	$submitted_form['private_key'],
	$submitted_form['connection_type']
);
}
2429
$ftp_constants = array(
'hostname'    => 'FTP_HOST',
'username'    => 'FTP_USER',
'password'    => 'FTP_PASS',
'public_key'  => 'FTP_PUBKEY',
'private_key' => 'FTP_PRIKEY',
);
2437
/*
* If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string.
* Otherwise, keep it as it previously was (saved details in option).
*/
foreach ( $ftp_constants as $key => $constant ) {
if ( defined( $constant ) ) {
	$credentials[ $key ] = constant( $constant );
} elseif ( ! empty( $submitted_form[ $key ] ) ) {
	$credentials[ $key ] = $submitted_form[ $key ];
} elseif ( ! isset( $credentials[ $key ] ) ) {
	$credentials[ $key ] = '';
}
}
2451
// Sanitize the hostname, some people might pass in odd data.
$credentials['hostname'] = preg_replace( '|\w+://|', '', $credentials['hostname'] ); // Strip any schemes off.
2454
if ( strpos( $credentials['hostname'], ':' ) ) {
list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 );
if ( ! is_numeric( $credentials['port'] ) ) {
	unset( $credentials['port'] );
}
} else {
unset( $credentials['port'] );
}
2463
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.
$credentials['connection_type'] = 'ftps';
} elseif ( ! empty( $submitted_form['connection_type'] ) ) {
$credentials['connection_type'] = $submitted_form['connection_type'];
} elseif ( ! isset( $credentials['connection_type'] ) ) { // All else fails (and it's not defaulted to something else saved), default to FTP.
$credentials['connection_type'] = 'ftp';
}
2473
if ( ! $error
&& ( ! empty( $credentials['hostname'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['password'] )
	|| 'ssh' === $credentials['connection_type'] && ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] )
)
) {
$stored_credentials = $credentials;
2480
if ( ! empty( $stored_credentials['port'] ) ) { // Save port as part of hostname to simplify above code.
	$stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
}
2484
unset(
	$stored_credentials['password'],
	$stored_credentials['port'],
	$stored_credentials['private_key'],
	$stored_credentials['public_key']
);
2491
if ( ! wp_installing() ) {
	update_option( 'ftp_credentials', $stored_credentials, false );
}
2495
return $credentials;
}
2498
$hostname        = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
$username        = isset( $credentials['username'] ) ? $credentials['username'] : '';
$public_key      = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
$private_key     = isset( $credentials['private_key'] ) ? $credentials['private_key'] : '';
$port            = isset( $credentials['port'] ) ? $credentials['port'] : '';
$connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : '';
2505
if ( $error ) {
$error_string = __( '<strong>Error:</strong> Could not connect to the server. Please verify the settings are correct.' );
if ( is_wp_error( $error ) ) {
	$error_string = esc_html( $error->get_error_message() );
}
wp_admin_notice(
	$error_string,
	array(
		'id'                 => 'message',
		'additional_classes' => array( 'error' ),
	)
);
}
2519
$types = array();
if ( extension_loaded( 'ftp' ) || extension_loaded( 'sockets' ) || function_exists( 'fsockopen' ) ) {
$types['ftp'] = __( 'FTP' );
}
if ( extension_loaded( 'ftp' ) ) { // Only this supports FTPS.
$types['ftps'] = __( 'FTPS (SSL)' );
}
if ( extension_loaded( 'ssh2' ) ) {
$types['ssh'] = __( 'SSH2' );
}
2530
/**
* Filters the connection types to output to the filesystem credentials form.
*
* @since 2.9.0
* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
*
* @param string[]      $types       Types of connections.
* @param array         $credentials Credentials to connect with.
* @param string        $type        Chosen filesystem method.
* @param bool|WP_Error $error       Whether the current request has failed to connect,
*                                   or an error object.
* @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 );
?>
2546<form action="<?php echo esc_url( $form_post ); ?>" method="post">
2547<div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form">
<?php
// Print a H1 heading in the FTP credentials modal dialog, default is a H2.
$heading_tag = 'h2';
if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) {
$heading_tag = 'h1';
}
echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>";
?>
2556<p id="request-filesystem-credentials-desc">
<?php
$label_user = __( 'Username' );
$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.' );
	$label_user = __( 'FTP/SSH Username' );
	$label_pass = __( 'FTP/SSH Password' );
} else {
	_e( 'Please enter your FTP credentials to proceed.' );
	$label_user = __( 'FTP Username' );
	$label_pass = __( 'FTP Password' );
}
echo ' ';
}
_e( 'If you do not remember your credentials, you should contact your web host.' );
2575
$hostname_value = esc_attr( $hostname );
if ( ! empty( $port ) ) {
$hostname_value .= ":$port";
}
2580
$password_value = '';
if ( defined( 'FTP_PASS' ) ) {
$password_value = '*****';
}
?>
2586</p>
2587<label for="hostname">
<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 $hostname_value; ?>"<?php disabled( defined( 'FTP_HOST' ) ); ?> />
2590</label>
2591<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' ) ); ?> />
</label>
2596</div>
2597<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 echo $password_value; ?>"<?php disabled( defined( 'FTP_PASS' ) ); ?> spellcheck="false" />
<?php
if ( ! defined( 'FTP_PASS' ) ) {
	_e( 'This password will not be stored on the server.' );
}
?>
</label>
2607</div>
2608<fieldset>
2609<legend><?php _e( 'Connection Type' ); ?></legend>
<?php
$disabled = disabled( ( defined( 'FTP_SSL' ) && FTP_SSL ) || ( defined( 'FTP_SSH' ) && FTP_SSH ), true, false );
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 ); ?> <?php echo $disabled; ?> />
<?php echo $text; ?>
</label>
<?php
endforeach;
?>
2621</fieldset>
<?php
if ( isset( $types['ssh'] ) ) {
$hidden_class = '';
if ( 'ssh' !== $connection_type ) {
	$hidden_class = ' class="hidden"';
}
?>
2629<fieldset id="ssh-keys"<?php echo $hidden_class; ?>>
2630<legend><?php _e( 'Authentication Keys' ); ?></legend>
2631<label for="public_key">
<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' ) ); ?> />
2634</label>
2635<label for="private_key">
<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' ) ); ?> />
2638</label>
2639<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>
2640</fieldset>
<?php
}
2643
foreach ( (array) $extra_fields as $field ) {
if ( isset( $submitted_form[ $field ] ) ) {
	echo '<input type="hidden" name="' . esc_attr( $field ) . '" value="' . esc_attr( $submitted_form[ $field ] ) . '" />';
}
}
2649
/*
* Make sure the `submit_button()` function is available during the REST API call
* from WP_Site_Health_Auto_Updates::test_check_wp_filesystem_method().
*/
if ( ! function_exists( 'submit_button' ) ) {
require_once ABSPATH . 'wp-admin/includes/template.php';
}
?>
<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' ), 'primary', 'upgrade', false ); ?>
</p>
2663</div>
2664</form>
<?php
return false;
2667}
2668
2669/**
* Prints the filesystem credentials modal when needed.
*
* @since 4.2.0
*/
2674function wp_print_request_filesystem_credentials_modal() {
$filesystem_method = get_filesystem_method();
2676
ob_start();
$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
ob_end_clean();
2680
$request_filesystem_credentials = ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored );
if ( ! $request_filesystem_credentials ) {
return;
}
?>
<div id="request-filesystem-credentials-dialog" class="notification-dialog-wrap request-filesystem-credentials-dialog">
<div class="notification-dialog-background"></div>
<div class="notification-dialog" role="dialog" aria-labelledby="request-filesystem-credentials-title" tabindex="0">
	<div class="request-filesystem-credentials-dialog-content">
		<?php request_filesystem_credentials( site_url() ); ?>
	</div>
</div>
</div>
<?php
2695}
2696
2697/**
* Attempts to clear the opcode cache for an individual PHP file.
*
* This function can be called safely without having to check the file extension
* or availability of the OPcache extension.
*
* Whether or not invalidation is possible is cached to improve performance.
*
* @since 5.5.0
*
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @param string $filepath Path to the file, including extension, for which the opcode cache is to be cleared.
* @param bool   $force    Invalidate even if the modification time is not newer than the file in cache.
*                         Default false.
* @return bool True if opcache was invalidated for `$filepath`, or there was nothing to invalidate.
*              False if opcache invalidation is not available, or is disabled via filter.
*/
2715function wp_opcache_invalidate( $filepath, $force = false ) {
static $can_invalidate = null;
2717
/*
* Check to see if WordPress is able to run `opcache_invalidate()` or not, and cache the value.
*
* First, check to see if the function is available to call, then if the host has restricted
* the ability to run the function to avoid a PHP warning.
*
* `opcache.restrict_api` can specify the path for files allowed to call `opcache_invalidate()`.
*
* If the host has this set, check whether the path in `opcache.restrict_api` matches
* the beginning of the path of the origin file.
*
* `$_SERVER['SCRIPT_FILENAME']` approximates the origin file's path, but `realpath()`
* is necessary because `SCRIPT_FILENAME` can be a relative path when run from CLI.
*
* For more details, see:
* - https://www.php.net/manual/en/opcache.configuration.php
* - https://www.php.net/manual/en/reserved.variables.server.php
* - https://core.trac.wordpress.org/ticket/36455
*/
if ( null === $can_invalidate
&& function_exists( 'opcache_invalidate' )
&& ( ! ini_get( 'opcache.restrict_api' )
	|| stripos( realpath( $_SERVER['SCRIPT_FILENAME'] ), ini_get( 'opcache.restrict_api' ) ) === 0 )
) {
$can_invalidate = true;
}
2744
// If invalidation is not available, return early.
if ( ! $can_invalidate ) {
return false;
}
2749
// Verify that file to be invalidated has a PHP extension.
if ( '.php' !== strtolower( substr( $filepath, -4 ) ) ) {
return false;
}
2754
/**
* Filters whether to invalidate a file from the opcode cache.
*
* @since 5.5.0
*
* @param bool   $will_invalidate Whether WordPress will invalidate `$filepath`. Default true.
* @param string $filepath        The path to the PHP file to invalidate.
*/
if ( apply_filters( 'wp_opcache_invalidate_file', true, $filepath ) ) {
return opcache_invalidate( $filepath, $force );
}
2766
return false;
2768}
2769
2770/**
* Attempts to clear the opcode cache for a directory of files.
*
* @since 6.2.0
*
* @see wp_opcache_invalidate()
* @link https://www.php.net/manual/en/function.opcache-invalidate.php
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $dir The path to the directory for which the opcode cache is to be cleared.
*/
2782function wp_opcache_invalidate_directory( $dir ) {
global $wp_filesystem;
2784
if ( ! is_string( $dir ) || '' === trim( $dir ) ) {
if ( WP_DEBUG ) {
	$error_message = sprintf(
		/* translators: %s: The function name. */
		__( '%s expects a non-empty string.' ),
		'<code>wp_opcache_invalidate_directory()</code>'
	);
	wp_trigger_error( '', $error_message );
}
return;
}
2796
$dirlist = $wp_filesystem->dirlist( $dir, false, true );
2798
if ( empty( $dirlist ) ) {
return;
}
2802
/*
* Recursively invalidate opcache of files in a directory.
*
* WP_Filesystem_*::dirlist() returns an array of file and directory information.
*
* This does not include a path to the file or directory.
* To invalidate files within sub-directories, recursion is needed
* to prepend an absolute path containing the sub-directory's name.
*
* @param array  $dirlist Array of file/directory information from WP_Filesystem_Base::dirlist(),
*                        with sub-directories represented as nested arrays.
* @param string $path    Absolute path to the directory.
*/
$invalidate_directory = static function ( $dirlist, $path ) use ( &$invalidate_directory ) {
$path = trailingslashit( $path );
2818
foreach ( $dirlist as $name => $details ) {
	if ( 'f' === $details['type'] ) {
		wp_opcache_invalidate( $path . $name, true );
	} elseif ( is_array( $details['files'] ) && ! empty( $details['files'] ) ) {
		$invalidate_directory( $details['files'], $path . $name );
	}
}
};
2827
$invalidate_directory( $dirlist, $dir );
2829}
2830