W3cubDocs

/WordPress

validate_file_to_edit( string $file, string[] $allowed_files = array() )

Makes sure that the file that was requested to be edited is allowed to be edited.

Description

Function will die if you are not allowed to edit the file.

Parameters

$file

(string) (Required) File the user is attempting to edit.

$allowed_files

(string[]) (Optional) Array of allowed files to edit. $file must match an entry exactly.

Default value: array()

Return

(string|void) Returns the file name on success, dies on failure.

Source

File: wp-admin/includes/file.php 

function validate_file_to_edit( $file, $allowed_files = array() ) {
	$code = validate_file( $file, $allowed_files );

	if ( ! $code ) {
		return $file;
	}

	switch ( $code ) {
		case 1:
			wp_die( __( 'Sorry, that file cannot be edited.' ) );

			// case 2 :
			// wp_die( __('Sorry, can’t call files with their real path.' ));

		case 3:
			wp_die( __( 'Sorry, that file cannot be edited.' ) );
	}
}

Uses

Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/functions.php: validate_file()

Validates a file name and path against an allowed set of rules.
wp-includes/functions.php: wp_die()

Kills WordPress execution and displays HTML page with an error message.

Changelog

Version Description
1.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/validate_file_to_edit