Documentation & API reference
Functions
Primary tabs
Name |
Location | Description | Direct uses | Strings |
|---|---|---|---|---|
| filter_xss |
drupal/ |
Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities. | 24 | |
| filter_xss_admin |
drupal/ |
Applies a very permissive XSS/HTML filter for admin-only use. | 23 | 1 |
| filter_xss_bad_protocol |
drupal/ |
Processes an HTML attribute value and strips dangerous protocols from URLs. | 1 | |
| fix_gpc_magic |
drupal/ |
Fixes double-escaping caused by "magic quotes" in some PHP installations. | 1 | |
| flood_clear_event |
drupal/ |
Makes the flood control mechanism forget an event for the current visitor. | 1 | |
| flood_is_allowed |
drupal/ |
Checks whether a user is allowed to proceed with the specified event. | 4 | |
| flood_register_event |
drupal/ |
Registers an event for the current visitor to the flood control mechanism. | 4 | |
| format_date |
drupal/ |
Formats a date, using a date type or a custom date format string. | 56 | |
| format_interval |
drupal/ |
Formats a time interval with the requested granularity. | 30 | 8 |
| format_plural |
drupal/ |
Formats a string containing a count of items. | 51 | |
| format_rss_channel |
drupal/ |
Formats an RSS channel. | 2 | |
| format_rss_item |
drupal/ |
Formats a single RSS item. | 2 | |
| format_size |
drupal/ |
Generates a string representation for the given byte count. | 18 | |
| format_string |
drupal/ |
Formats a string for HTML display by replacing variable placeholders. | 253 | 1 |
| format_username |
drupal/ |
Format a username. | 31 | 1 |
| format_xml_elements |
drupal/ |
Formats XML elements. | 4 | |
| form_builder |
drupal/ |
Builds and processes all elements in the structured form array. | 3 | |
| form_clear_error |
drupal/ |
Clears all errors against all form elements made by form_set_error(). | 3 | |
| form_error |
drupal/ |
Flags an element as having an error. | 28 | |
| form_execute_handlers |
drupal/ |
Executes custom validation and submission handlers for a given form. | 3 | |
| form_get_cache |
drupal/ |
Fetches a form from cache. | 5 | |
| form_get_error |
drupal/ |
Returns the error message filed against the given form element. | 1 | |
| form_get_errors |
drupal/ |
Returns an associative array of all errors. | 12 | |
| form_get_options |
drupal/ |
Returns the indexes of a select element's options matching a given key. | ||
| form_label_test_form |
drupal/ |
A form for testing form labels and required marks. | 1 | |
| form_load_include |
drupal/ |
Ensures an include file is loaded whenever the form is processed. | 1 | |
| form_options_flatten |
drupal/ |
Allows PHP array processing of multiple select options with the same value. | 3 | |
| form_pre_render_conditional_form_element |
drupal/ |
Adds form element theming to an element if its title or description is set. | 1 | |
| form_pre_render_fieldset |
drupal/ |
Adds members of this group as actual elements for rendering. | 1 | |
| form_process_actions |
drupal/ |
Processes a form actions container element. | 1 | |
| form_process_autocomplete |
drupal/ |
Process function to prepare autocomplete data. | 1 | |
| form_process_checkbox |
drupal/ |
Sets the #checked property of a checkbox element. | 1 | |
| form_process_checkboxes |
drupal/ |
Processes a checkboxes form element. | 1 | |
| form_process_container |
drupal/ |
Processes a container element. | 1 | |
| form_process_date |
drupal/ |
Expands a date element into year, month, and day select elements. | 1 | |
| form_process_fieldset |
drupal/ |
Arranges fieldsets into groups. | 1 | |
| form_process_machine_name |
drupal/ |
Processes a machine-readable name form element. | 1 | |
| form_process_password_confirm |
drupal/ |
Expand a password_confirm field into two text boxes. | 1 | |
| form_process_radios |
drupal/ |
Expands a radios element into individual radio elements. | 1 | |
| form_process_select |
drupal/ |
Processes a select list form element. | 1 | |
| form_process_tableselect |
drupal/ |
Creates checkbox or radio elements to populate a tableselect table. | 1 | |
| form_process_vertical_tabs |
drupal/ |
Creates a group formatted as vertical tabs. | 1 | |
| form_process_weight |
drupal/ |
Expands a weight element into a select element. | 1 | |
| form_select_options |
drupal/ |
Converts an array of options into HTML, for use in select list form elements. | 1 | |
| form_set_cache |
drupal/ |
Stores a form in the cache. | 5 | |
| form_set_error |
drupal/ |
Files an error against a form element. | 85 | 1 |
| form_set_value |
drupal/ |
Changes submitted form values during form validation. | 24 | |
| form_state_defaults |
drupal/ |
Retrieves default values for the $form_state array. | 9 | |
| form_state_keys_no_cache |
drupal/ |
Returns an array of $form_state keys that shouldn't be cached. | 2 | |
| form_state_values_clean |
drupal/ |
Removes internal Form API elements and buttons from submitted form values. | 8 |