Documentation & API reference
Functions
Primary tabs
| Name |
Location |
Description | Direct uses | Strings |
|---|---|---|---|---|
| file_delete_multiple |
drupal/ |
Deletes files. | 1 | |
| file_unmanaged_delete |
drupal/ |
Deletes a file without database changes or hook invocations. | 14 | |
| file_unmanaged_delete_recursive |
drupal/ |
Deletes all files and directories in the specified filepath recursively. | 13 | |
| file_save_upload |
drupal/ |
Saves file uploads to a new location. | 7 | |
| drupal_move_uploaded_file |
drupal/ |
Moves an uploaded file to a new location. | 1 | |
| file_unmanaged_save_data |
drupal/ |
Saves a file to the specified destination without invoking file API. | 11 | |
| file_download |
drupal/ |
Page callback: Handles private file transfers. | 2 | 1 |
| file_scan_directory |
drupal/ |
Finds all files that match a given mask in a given directory. | 24 | |
| file_upload_max_size |
drupal/ |
Determines the maximum file upload size by querying the PHP settings. | 5 | |
| file_get_mimetype |
drupal/ |
Determines an Internet Media Type or MIME type from a filename. | 4 | |
| drupal_chmod |
drupal/ |
Sets the permissions on a file or directory. | 10 | |
| drupal_unlink |
drupal/ |
Deletes a file. | 20 | |
| drupal_realpath |
drupal/ |
Returns the absolute local filesystem path of a stream URI. | 42 | |
| drupal_dirname |
drupal/ |
Gets the name of the directory from a given path. | 6 | |
| drupal_basename |
drupal/ |
Gets the filename from a given path. | 37 | |
| drupal_mkdir |
drupal/ |
Creates a directory, optionally creating missing components in the path to the directory. | 11 | |
| _drupal_mkdir_call |
drupal/ |
Helper function. Ensures we don't pass a NULL as a context resource to mkdir(). | 1 | |
| drupal_rmdir |
drupal/ |
Removes a directory. | 6 | |
| drupal_tempnam |
drupal/ |
Creates a file with a unique filename in the specified directory. | 4 | |
| file_directory_temp |
drupal/ |
Gets and sets the path of the configured temporary directory. | 4 | |
| file_directory_os_temp |
drupal/ |
Discovers a writable system-appropriate temporary directory. | 2 | |
| file_mimetype_mapping |
drupal/ |
Return an array of MIME extension mappings. | 1 | |
| file_default_mimetype_mapping |
drupal/ |
Default MIME extension mapping. | 1 | |
| _drupal_form_id |
drupal/ |
Determines the form ID. | 3 | |
| drupal_get_form |
drupal/ |
Returns a renderable form array for a given form ID. | 28 | 26 |
| drupal_build_form |
drupal/ |
Builds and processes a form for a given form ID. | 8 | |
| form_state_defaults |
drupal/ |
Retrieves default values for the $form_state array. | 11 | |
| drupal_rebuild_form |
drupal/ |
Constructs a new $form from the information in $form_state. | 2 | |
| form_get_cache |
drupal/ |
Fetches a form from the cache. | 4 | |
| form_set_cache |
drupal/ |
Stores a form in the cache. | 4 | |
| form_state_keys_no_cache |
drupal/ |
Returns an array of $form_state keys that shouldn't be cached. | 2 | |
| form_load_include |
drupal/ |
Ensures an include file is loaded whenever the form is processed. | 10 | |
| drupal_form_submit |
drupal/ |
Retrieves, populates, and processes a form. | 6 | |
| drupal_retrieve_form |
drupal/ |
Retrieves the structured array that defines a given form. | 3 | |
| drupal_process_form |
drupal/ |
Processes a form submission. | 7 | |
| drupal_prepare_form |
drupal/ |
Prepares a structured form array. | 6 | |
| drupal_validate_form |
drupal/ |
Validates user-submitted form data in the $form_state array. | 1 | |
| drupal_redirect_form |
drupal/ |
Redirects the user to a URL after a form has been processed. | 2 | |
| _form_validate |
drupal/ |
Performs validation on form elements. | 1 | |
| form_execute_handlers |
drupal/ |
Executes custom validation and submission handlers for a given form. | 4 | |
| form_set_error |
drupal/ |
Files an error against a form element. | 88 | 1 |
| form_clear_error |
drupal/ |
Clears all errors against all form elements made by form_set_error(). | 3 | |
| form_get_errors |
drupal/ |
Returns an associative array of all errors. | 16 | |
| form_get_error |
drupal/ |
Returns the error message filed against the given form element. | 1 | |
| form_error |
drupal/ |
Flags an element as having an error. | 47 | |
| form_builder |
drupal/ |
Builds and processes all elements in the structured form array. | 2 | |
| _form_builder_handle_input_element |
drupal/ |
Adds the #name and #value properties of an input element before rendering. | 1 | |
| _form_element_triggered_scripted_submission |
drupal/ |
Detects if an element triggered the form submission via Ajax. | 1 | |
| _form_button_was_clicked |
drupal/ |
Determines if a given button triggered the form submission. | 1 | |
| form_state_values_clean |
drupal/ |
Removes internal Form API elements and buttons from submitted form values. | 10 |