public FormState::loadInclude($module, $type, $name = NULL)
Ensures an include file is loaded whenever the form is processed.
Example:
1 2 | // Load node.admin.inc from Node module.$form_state->loadInclude('node', 'inc', 'node.admin'); |
Use this function instead of module_load_include() from inside a form constructor or any form processing logic as it ensures that the include file is loaded whenever the form is processed. In contrast to using module_load_include() directly, this method makes sure the include file is correctly loaded also if the form is cached.
Parameters
string $module: The module to which the include file belongs.
string $type: The include file's type (file extension).
string|null $name: (optional) The base file name (without the $type extension). If omitted, $module is used; i.e., resulting in "$module.$type" by default.
Return value
string|false The filepath of the loaded include file, or FALSE if the include file was not found or has been loaded already.
Overrides FormStateInterface::loadInclude
See also
File
- core/lib/Drupal/Core/Form/FormState.php, line 857
Class
- FormState
- Stores information about the state of a form.
Namespace
Drupal\Core\Form
Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | public function loadInclude($module, $type, $name = NULL) { if (!isset($name)) { $name = $module; } $build_info = $this->getBuildInfo(); if (!isset($build_info['files']["$module:$name.$type"])) { // Only add successfully included files to the form state. if ($result = $this->moduleLoadInclude($module, $type, $name)) { $build_info['files']["$module:$name.$type"] = array( 'type' => $type, 'module' => $module, 'name' => $name, ); $this->setBuildInfo($build_info); return $result; } } return FALSE;} |
Please login to continue.