Documentation & API reference
Constants
Primary tabs
| Name |
Location |
Description | Direct uses | Strings |
|---|---|---|---|---|
| BLOCK_REGION_NONE |
drupal/ |
Denotes that a block is not enabled in any region and should not be shown. | 7 | 1 |
| BLOCK_CUSTOM_FIXED |
drupal/ |
Users cannot control whether or not they see this block. | 2 | 1 |
| BLOCK_CUSTOM_ENABLED |
drupal/ |
Shows this block by default, but lets individual users hide it. | 2 | 1 |
| BLOCK_CUSTOM_DISABLED |
drupal/ |
Hides this block by default but lets individual users show it. | 1 | 1 |
| BLOCK_VISIBILITY_NOTLISTED |
drupal/ |
Shows this block on every page except the listed pages. | 1 | 1 |
| BLOCK_VISIBILITY_LISTED |
drupal/ |
Shows this block on only the listed pages. | 3 | 1 |
| BLOCK_VISIBILITY_PHP |
drupal/ |
Shows this block if the associated PHP code returns TRUE. | 2 | 1 |
| AGGREGATOR_CLEAR_NEVER |
drupal/ |
Denotes that a feed's items should never expire. | 4 | 1 |
| DRUPAL_ROOT |
drupal/ |
Defines the root directory of the Drupal installation. | 162 | 9 |
| MAINTENANCE_MODE |
drupal/ |
Global flag to indicate the site is in installation mode. | 10 | 20 |
| DRUPAL_ROOT |
drupal/ |
Root directory of Drupal installation. | 162 | 9 |
| REQUIRED_D6_SCHEMA_VERSION |
drupal/ |
Minimum schema version of Drupal 6 required for upgrade to Drupal 7. | 1 | 1 |
| UNICODE_ERROR |
drupal/ |
Indicates an error during check for PHP unicode support. | 1 | 1 |
| UNICODE_SINGLEBYTE |
drupal/ |
Indicates that standard PHP (emulated) unicode support is being used. | 3 | 1 |
| UNICODE_MULTIBYTE |
drupal/ |
Indicates that full unicode support with the PHP mbstring extension is being used. | 6 | 1 |
| PREG_CLASS_UNICODE_WORD_BOUNDARY |
drupal/ |
Matches Unicode characters that are word boundaries. | 3 | 1 |
| MARK_READ |
drupal/ |
Mark content as read. | 2 | 1 |
| MARK_NEW |
drupal/ |
Mark content as being new. | 3 | 1 |
| MARK_UPDATED |
drupal/ |
Mark content as being updated. | 2 | 1 |
| STREAM_WRAPPERS_ALL |
drupal/ |
Stream wrapper bit flag -- a filter that matches all wrappers. | 1 | |
| STREAM_WRAPPERS_LOCAL |
drupal/ |
Stream wrapper bit flag -- refers to a local file system location. | 3 | 1 |
| STREAM_WRAPPERS_READ |
drupal/ |
Stream wrapper bit flag -- wrapper is readable (almost always true). | 1 | 1 |
| STREAM_WRAPPERS_WRITE |
drupal/ |
Stream wrapper bit flag -- wrapper is writeable. | 1 | 1 |
| STREAM_WRAPPERS_VISIBLE |
drupal/ |
Stream wrapper bit flag -- exposed in the UI and potentially web accessible. | 1 | 1 |
| STREAM_WRAPPERS_HIDDEN |
drupal/ |
Stream wrapper type flag -- not visible in the UI or accessible via web, but readable and writable. E.g. the temporary directory for uploads. | 1 | 1 |
| STREAM_WRAPPERS_LOCAL_HIDDEN |
drupal/ |
Stream wrapper type flag -- hidden, readable and writeable using local files. | 2 | 1 |
| STREAM_WRAPPERS_WRITE_VISIBLE |
drupal/ |
Stream wrapper type flag -- visible, readable and writeable. | 6 | 1 |
| STREAM_WRAPPERS_READ_VISIBLE |
drupal/ |
Stream wrapper type flag -- visible and read-only. | 1 | 1 |
| STREAM_WRAPPERS_NORMAL |
drupal/ |
Stream wrapper type flag -- the default when 'type' is omitted from hook_stream_wrappers(). This does not include STREAM_WRAPPERS_LOCAL, because PHP grants a greater trust level to local files (for example, they can be used in an… | 2 | 1 |
| STREAM_WRAPPERS_LOCAL_NORMAL |
drupal/ |
Stream wrapper type flag -- visible, readable and writeable using local files. | 2 | 1 |
| DRUPAL_HASH_COUNT |
drupal/ |
The standard log2 number of iterations for password stretching. This should increase by 1 every Drupal version in order to counteract increases in the speed and power of computers available to crack the hashes. | 3 | 1 |
| DRUPAL_MIN_HASH_COUNT |
drupal/ |
The minimum allowed log2 number of iterations for password stretching. | 3 | 1 |
| DRUPAL_MAX_HASH_COUNT |
drupal/ |
The maximum allowed log2 number of iterations for password stretching. | 2 | 1 |
| DRUPAL_HASH_LENGTH |
drupal/ |
The expected (and maximum) number of characters in a hashed password. | 2 | 1 |
| MENU_IS_ROOT |
drupal/ |
Internal menu flag -- menu item is the root of the menu tree. | 1 | |
| MENU_VISIBLE_IN_TREE |
drupal/ |
Internal menu flag -- menu item is visible in the menu tree. | 2 | 1 |
| MENU_VISIBLE_IN_BREADCRUMB |
drupal/ |
Internal menu flag -- menu item is visible in the breadcrumb. | 8 | 1 |
| MENU_LINKS_TO_PARENT |
drupal/ |
Internal menu flag -- menu item links back to its parent. | 3 | 1 |
| MENU_MODIFIED_BY_ADMIN |
drupal/ |
Internal menu flag -- menu item can be modified by administrator. | 1 | |
| MENU_CREATED_BY_ADMIN |
drupal/ |
Internal menu flag -- menu item was created by administrator. | 1 | |
| MENU_IS_LOCAL_TASK |
drupal/ |
Internal menu flag -- menu item is a local task. | 3 | 1 |
| MENU_IS_LOCAL_ACTION |
drupal/ |
Internal menu flag -- menu item is a local action. | 1 | 1 |
| MENU_NORMAL_ITEM |
drupal/ |
Menu type -- A "normal" menu item that's shown in menu and breadcrumbs. | 4 | 1 |
| MENU_CALLBACK |
drupal/ |
Menu type -- A hidden, internal callback, typically used for API calls. | 36 | 1 |
| MENU_SUGGESTED_ITEM |
drupal/ |
Menu type -- A normal menu item, hidden until enabled by an administrator. | 11 | 1 |
| MENU_LOCAL_TASK |
drupal/ |
Menu type -- A task specific to the parent item, usually rendered as a tab. | 25 | 1 |
| MENU_DEFAULT_LOCAL_TASK |
drupal/ |
Menu type -- The "default" local task, which is initially active. | 22 | 1 |
| MENU_LOCAL_ACTION |
drupal/ |
Menu type -- An action specific to the parent, usually rendered as a link. | 16 | 1 |
| MENU_CONTEXT_NONE |
drupal/ |
Internal menu flag: Invisible local task. | 2 | 1 |
| MENU_CONTEXT_PAGE |
drupal/ |
Internal menu flag: Local task should be displayed in page context. | 4 | 1 |