Documentation & API reference
Constants
Primary tabs
| Name |
Location |
Description | Direct uses | Strings |
|---|---|---|---|---|
| MENU_IS_LOCAL_TASK |
drupal/ |
Internal menu flag -- menu item is a local task. | 3 | |
| MENU_IS_LOCAL_ACTION |
drupal/ |
Internal menu flag -- menu item is a local action. | 1 | |
| MENU_NORMAL_ITEM |
drupal/ |
Menu type -- A "normal" menu item that's shown in menu and breadcrumbs. | 6 | 1 |
| MENU_CALLBACK |
drupal/ |
Menu type -- A hidden, internal callback, typically used for API calls. | 35 | |
| MENU_SUGGESTED_ITEM |
drupal/ |
Menu type -- A normal menu item, hidden until enabled by an administrator. | 8 | 1 |
| MENU_LOCAL_TASK |
drupal/ |
Menu type -- A task specific to the parent item, usually rendered as a tab. | 28 | 1 |
| MENU_DEFAULT_LOCAL_TASK |
drupal/ |
Menu type -- The "default" local task, which is initially active. | 36 | 1 |
| MENU_LOCAL_ACTION |
drupal/ |
Menu type -- An action specific to the parent, usually rendered as a link. | 17 | 1 |
| MENU_SIBLING_LOCAL_TASK |
drupal/ |
Menu type -- A task specific to the parent, which is never rendered. | 2 | 1 |
| MENU_CONTEXT_NONE |
drupal/ |
Internal menu flag: Invisible local task. | 2 | |
| MENU_CONTEXT_PAGE |
drupal/ |
Internal menu flag: Local task should be displayed in page context. | 9 | |
| MENU_CONTEXT_INLINE |
drupal/ |
Internal menu flag: Local task should be displayed inline. | 11 | |
| MENU_NOT_FOUND |
drupal/ |
Internal menu status code -- Menu item was not found. | 2 | |
| MENU_ACCESS_DENIED |
drupal/ |
Internal menu status code -- Menu item access is denied. | 1 | |
| MENU_SITE_OFFLINE |
drupal/ |
Internal menu status code -- Menu item inaccessible because site is offline. | 4 | |
| MENU_SITE_ONLINE |
drupal/ |
Internal menu status code -- Everything is working fine. | 4 | |
| MENU_MAX_PARTS |
drupal/ |
The maximum number of path elements for a menu callback | 4 | |
| MENU_MAX_DEPTH |
drupal/ |
The maximum depth of a menu links tree - matches the number of p columns. | 18 | |
| MENU_PREFERRED_LINK |
drupal/ |
Reserved key to identify the most specific menu link for a given path. | 1 | |
| MAIL_LINE_ENDINGS |
drupal/ |
Auto-detect appropriate line endings for e-mails. | 3 | 1 |
| LANGUAGE_NEGOTIATION_SELECTED |
drupal/ |
No language negotiation. The default language is used. | 6 | |
| 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 | |
| INSTALL_TASK_SKIP |
drupal/ |
Do not run the task during the current installation request. | 3 | |
| INSTALL_TASK_RUN_IF_REACHED |
drupal/ |
Run the task on each installation request that reaches it. | 2 | |
| INSTALL_TASK_RUN_IF_NOT_COMPLETED |
drupal/ |
Run the task on each installation request until the database is set up. | 3 | |
| 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 | |
| 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. | 3 | 1 |
| STREAM_WRAPPERS_WRITE_VISIBLE |
drupal/ |
Stream wrapper type flag -- visible, readable and writeable. | 5 | 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… | 1 | 1 |
| STREAM_WRAPPERS_LOCAL_NORMAL |
drupal/ |
Stream wrapper type flag -- visible, readable and writeable using local files. | 2 | 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 |