API for handling file uploads and server file management.

File

core/includes/file.inc

Functions

Namesort descending Description
backdrop_basename Gets the filename from a given path.
backdrop_chmod Sets the permissions on a file or directory.
backdrop_dirname Gets the name of the directory from a given path.
backdrop_mkdir Creates a directory using Backdrop's default mode.
backdrop_move_uploaded_file Moves an uploaded file to a new location.
backdrop_realpath Resolves the absolute filepath of a local URI or filepath.
backdrop_rmdir Removes a directory.
backdrop_tempnam Creates a file with a unique filename in the specified directory.
backdrop_unlink Deletes a file.
file_build_uri Constructs a URI to Backdrop's default files location given a relative path.
file_copy Copies a file to a new location and adds a file record to the database.
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_temp Gets the path of system-appropriate temporary directory.
file_download Page callback: Handles private file transfers.
file_download_access Checks that the current user has access to a particular file.
file_download_headers Retrieves headers for a private file download.
file_ensure_htaccess Creates a .htaccess file in each files directory if it is missing.
file_get_content_headers Examines a file entity and returns appropriate content headers for download.
file_get_mimetype Determines an Internet Media Type or MIME type from a filename.
file_get_stream_wrappers Provides Backdrop stream wrapper registry.
file_htaccess_lines Returns the standard .htaccess lines that Backdrop adds to file directories.
file_load Loads a single file entity from the database.
file_load_multiple Loads file entities from the database.
file_move Moves a file to a new location and update the file's database entry.
file_munge_filename Modifies a filename as needed for security purposes.
file_prepare_directory Checks that the directory exists and is writable.
file_save Saves a new or updated file.
file_save_data Saves a file to the specified destination and creates a database entry.
file_save_htaccess Creates a .htaccess file in the given directory.
file_save_upload Saves a file upload to a new location.
file_scan_directory Finds all files that match a given mask in a given directory.
file_space_used Determines total disk space used by a single user or the whole filesystem.
file_stream_wrapper_get_class Returns the stream wrapper class name for a given scheme.
file_stream_wrapper_get_instance_by_scheme Returns a reference to the stream wrapper class responsible for a scheme.
file_stream_wrapper_get_instance_by_uri Returns a reference to the stream wrapper class responsible for a given URI.
file_stream_wrapper_uri_normalize Normalizes a URI by making it syntactically correct.
file_stream_wrapper_valid_scheme Checks that the scheme of a stream URI is valid.
file_transfer Transfers a file to the client using HTTP.
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. This is a powerful function that in many ways performs like an advanced version of rename().
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 Returns the scheme of a URI (e.g. a stream).
file_uri_target Returns the part of a URI after the schema.
file_usage_add Records that a module is using a file.
file_usage_delete Removes a record to indicate that a module is no longer using a file.
file_usage_list Determines where a file is used.
file_validate Checks that a file meets the criteria specified by the validators.
file_validate_extensions Checks that the filename ends with an allowed extension.
file_validate_image_orientation Check for EXIF orientation data and rotate file if needed.
file_validate_image_resolution Verifies that image dimensions are within the specified maximum and minimum.
file_validate_is_image Checks that the file is recognized by image_get_info() as an image.
file_validate_name_length Checks for files with names longer than can be stored in the database.
file_validate_size Checks that the file's size is below certain limits.
file_valid_uri Determines whether the URI has a valid scheme for file API operations.

Constants

Namesort descending Description
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.