W3cubDocs

/Drupal 8

file.inc

API for handling file uploads and server file management.

File

core/includes/file.inc

Functions

Name Description
drupal_basename Deprecated Gets the filename from a given path.
drupal_chmod Deprecated Sets the permissions on a file or directory.
drupal_dirname Deprecated Gets the name of the directory from a given path.
drupal_mkdir Deprecated Creates a directory, optionally creating missing components in the path to the directory.
drupal_move_uploaded_file Deprecated Moves an uploaded file to a new location.
drupal_realpath Deprecated Resolves the absolute filepath of a local URI or filepath.
drupal_rmdir Deprecated Removes a directory.
drupal_tempnam Deprecated Creates a file with a unique filename in the specified directory.
drupal_unlink Deprecated Deletes a file.
file_build_uri Constructs a URI to Drupal's default files location given a relative path.
file_create_filename Creates a full file path from a directory and filename.
file_create_url Creates a web-accessible URL for a stream to an external or local file.
file_default_scheme Gets the default file stream implementation.
file_delete Deletes a file and its database record.
file_delete_multiple Deletes files.
file_destination Determines the destination path for a file.
file_directory_os_temp Discovers a writable system-appropriate temporary directory.
file_directory_temp Gets and sets the path of the configured temporary directory.
file_ensure_htaccess Creates a .htaccess file in each Drupal files directory if it is missing.
file_htaccess_lines Deprecated Returns the standard .htaccess lines that Drupal writes to file directories.
file_munge_filename Modifies a filename as needed for security purposes.
file_prepare_directory Checks that the directory exists and is writable.
file_save_htaccess Creates a .htaccess file in the given directory.
file_scan_directory Finds all files that match a given mask in a given directory.
file_stream_wrapper_uri_normalize Normalizes a URI by making it syntactically correct.
file_stream_wrapper_valid_scheme Deprecated Checks that the scheme of a stream URI is valid.
file_unmanaged_copy Copies a file to a new location without database changes or hook invocation.
file_unmanaged_delete Deletes a file without database changes or hook invocations.
file_unmanaged_delete_recursive Deletes all files and directories in the specified filepath recursively.
file_unmanaged_move Moves a file to a new location without database changes or hook invocation.
file_unmanaged_prepare Internal function that prepares the destination for a file_unmanaged_copy or file_unmanaged_move operation.
file_unmanaged_save_data Saves a file to the specified destination without invoking file API.
file_unmunge_filename Undoes the effect of file_munge_filename().
file_upload_max_size Determines the maximum file upload size by querying the PHP settings.
file_uri_scheme Deprecated Returns the scheme of a URI (e.g. a stream).
file_uri_target Returns the part of a URI after the schema.
file_url_transform_relative Transforms an absolute URL of a local file to a relative URL.
file_valid_uri Determines whether the URI has a valid scheme for file API operations.

Constants

Name Description
FILE_CHMOD_DIRECTORY Deprecated Default mode for new directories. See drupal_chmod().
FILE_CHMOD_FILE Deprecated Default mode for new files. See drupal_chmod().
FILE_CREATE_DIRECTORY Flag used by file_prepare_directory() -- create directory if not present.
FILE_EXISTS_ERROR Flag for dealing with existing files: Do nothing and return FALSE.
FILE_EXISTS_RENAME Flag for dealing with existing files: Appends number until name is unique.
FILE_EXISTS_REPLACE Flag for dealing with existing files: Replace the existing file.
FILE_MODIFY_PERMISSIONS Flag used by file_prepare_directory() -- file permissions may be changed.
FILE_STATUS_PERMANENT Indicates that the file is permanent and should not be deleted.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!includes!file.inc/8.1.x