Documentation & API reference
Constants
Primary tabs
| Name | Location | Description | Direct uses |
Strings |
|---|---|---|---|---|
| REQUIREMENT_INFO |
drupal/ |
Requirement severity -- Informational message only. | 3 | |
| REQUIREMENT_OK |
drupal/ |
Requirement severity -- Requirement successfully met. | 2 | |
| REQUIREMENT_WARNING |
drupal/ |
Requirement severity -- Warning condition; proceed but flag warning. | 12 | |
| REQUIREMENT_ERROR |
drupal/ |
Requirement severity -- Error condition; abort installation. | 19 | |
| FILE_EXIST |
drupal/ |
File permission check -- File exists. | 6 | |
| FILE_READABLE |
drupal/ |
File permission check -- File is readable. | 7 | |
| FILE_WRITABLE |
drupal/ |
File permission check -- File is writable. | 6 | |
| FILE_EXECUTABLE |
drupal/ |
File permission check -- File is executable. | 3 | |
| FILE_NOT_EXIST |
drupal/ |
File permission check -- File does not exist. | 1 | |
| FILE_NOT_READABLE |
drupal/ |
File permission check -- File is not readable. | 3 | |
| FILE_NOT_WRITABLE |
drupal/ |
File permission check -- File is not writable. | 5 | |
| FILE_NOT_EXECUTABLE |
drupal/ |
File permission check -- File is not executable. | 3 | |
| REQUIRED_D7_SCHEMA_VERSION |
drupal/ |
Minimum schema version of Drupal 7 required for upgrade to Drupal 8. | 1 | |
| SCHEMA_UNINSTALLED |
drupal/ |
Indicates that a module has not been installed yet. | 12 | |
| SCHEMA_INSTALLED |
drupal/ |
Indicates that a module has been installed. | 2 | |
| STREAM_WRAPPERS_ALL |
drupal/ |
Stream wrapper bit flag -- a filter that matches all wrappers. | ||
| STREAM_WRAPPERS_LOCAL |
drupal/ |
Stream wrapper bit flag -- refers to a local file system location. | 2 | |
| STREAM_WRAPPERS_READ |
drupal/ |
Stream wrapper bit flag -- wrapper is readable (almost always true). | 1 | |
| STREAM_WRAPPERS_WRITE |
drupal/ |
Stream wrapper bit flag -- wrapper is writeable. | 1 | |
| STREAM_WRAPPERS_VISIBLE |
drupal/ |
Stream wrapper bit flag -- exposed in the UI and potentially web accessible. | 1 | |
| FILE_CREATE_DIRECTORY |
drupal/ |
Flag used by file_prepare_directory() -- create directory if not present. | 24 | |
| FILE_MODIFY_PERMISSIONS |
drupal/ |
Flag used by file_prepare_directory() -- file permissions may be changed. | 10 | |
| FILE_EXISTS_RENAME |
drupal/ |
Flag for dealing with existing files: Appends number until name is unique. | 18 | |
| FILE_EXISTS_REPLACE |
drupal/ |
Flag for dealing with existing files: Replace the existing file. | 26 | |
| FILE_EXISTS_ERROR |
drupal/ |
Flag for dealing with existing files: Do nothing and return FALSE. | 12 | |
| FILE_STATUS_PERMANENT |
drupal/ |
Indicates that the file is permanent and should not be deleted. | 19 | |
| MARK_READ |
drupal/ |
Mark content as read. | 3 | |
| MARK_NEW |
drupal/ |
Mark content as being new. | 4 | |
| MARK_UPDATED |
drupal/ |
Mark content as being updated. | 3 | |
| RESPONSIVE_PRIORITY_MEDIUM |
drupal/ |
A responsive table class; hide table cell on narrow devices. | 6 | |
| RESPONSIVE_PRIORITY_LOW |
drupal/ |
A responsive table class; only show table cell on wide devices. | 6 | |
| SAVED_NEW |
drupal/ |
Return status for saving which involved creating a new item. | 14 | |
| SAVED_UPDATED |
drupal/ |
Return status for saving which involved an update to an existing item. | 19 | |
| SAVED_DELETED |
drupal/ |
Return status for saving which deleted an existing item. | ||
| CSS_AGGREGATE_DEFAULT |
drupal/ |
The default aggregation group for CSS files added to the page. | 2 | |
| CSS_AGGREGATE_THEME |
drupal/ |
The default aggregation group for theme CSS files added to the page. | 2 | |
| CSS_BASE |
drupal/ |
The default weight for CSS rules that style HTML elements ("base" styles). | ||
| CSS_LAYOUT |
drupal/ |
The default weight for CSS rules that layout a page. | ||
| CSS_COMPONENT |
drupal/ |
The default weight for CSS rules that style design components (and their associated states and skins.) | 1 | |
| CSS_STATE |
drupal/ |
The default weight for CSS rules that style states and are not included with components. | ||
| CSS_SKIN |
drupal/ |
The default weight for CSS rules that style skins and are not included with components. | 1 | |
| JS_SETTING |
drupal/ |
The default group for JavaScript settings added to the page. | 1 | |
| JS_LIBRARY |
drupal/ |
The default group for JavaScript and jQuery libraries added to the page. | 6 | |
| JS_DEFAULT |
drupal/ |
The default group for module JavaScript code added to the page. | 5 | |
| JS_THEME |
drupal/ |
The default group for theme JavaScript code added to the page. | 2 | |
| DRUPAL_NO_CACHE |
drupal/ |
The block should not get cached. | 13 | |
| DRUPAL_CACHE_CUSTOM |
drupal/ |
The block is handling its own caching in its hook_block_view(). | 2 | |
| DRUPAL_CACHE_PER_ROLE |
drupal/ |
The block or element can change depending on the user's roles. | 5 | |
| DRUPAL_CACHE_PER_USER |
drupal/ |
The block or element can change depending on the user. | 2 | |
| DRUPAL_CACHE_PER_PAGE |
drupal/ |
The block or element can change depending on the page being viewed. | 3 |