WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

validate_file_to_edit()

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

In this article

Back to top

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

$filestringrequired
File the user is attempting to edit.
$allowed_filesstring[]optional
Array of allowed files to edit.
$file must match an entry exactly.

Default:array()

Return

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

Source

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, cannot call files with their real path.' ));

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

View all references View on Trac View on GitHub

UsesDescription
validate_file()wp-includes/functions.php

Validates a file name and path against an allowed set of rules.

wp_die()wp-includes/functions.php

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

Changelog

VersionDescription
1.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.