function ModuleHandlerInterface::loadInclude

Same name in other branches
  1. 9 core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php \Drupal\Core\Extension\ModuleHandlerInterface::loadInclude()
  2. 8.9.x core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php \Drupal\Core\Extension\ModuleHandlerInterface::loadInclude()
  3. 11.x core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php \Drupal\Core\Extension\ModuleHandlerInterface::loadInclude()

Loads a module include file.

Examples:

// Load node.admin.inc from the node module.
$this->loadInclude('node', 'inc', 'node.admin');
// Load content_types.inc from the node module.
$this->loadInclude('node', 'inc', 'content_types');

Parameters

string $module: The module to which the include file belongs.

string $type: The include file's type (file extension).

string $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 name of the included file, if successful; FALSE otherwise.

File

core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php, line 163

Class

ModuleHandlerInterface
Interface for classes that manage a set of enabled modules.

Namespace

Drupal\Core\Extension

Code

public function loadInclude($module, $type, $name = NULL);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.