1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Extension
  7. \
  8. ModuleHandlerInterface

ModuleHandlerInterface

interface ModuleHandlerInterface (View source)

Interface for classes that manage a set of enabled modules.

Classes implementing this interface work with a fixed list of modules and are responsible for loading module files and maintaining information about module dependencies and hook implementations.

Methods

bool
load(string $name)

Includes a module's .module file.

loadAll()

Loads all enabled modules.

bool
isLoaded()

Returns whether all modules have been loaded.

reload()

Reloads all enabled modules.

Extension[]
getModuleList()

Returns the list of currently active modules.

Extension
getModule(string $name)

Returns a module extension object from the currently active modules list.

setModuleList(array $module_list = [])

Sets an explicit list of currently active modules.

addModule(string $name, string $path)

Adds a module to the list of currently active modules.

addProfile(string $name, string $path)

Adds an installation profile to the list of currently active modules.

The
buildModuleDependencies(array $modules)

Determines which modules require and are required by each module.

bool
moduleExists(string $module)

Determines whether a given module is enabled.

loadAllIncludes(string $type, string $name = NULL)

Loads an include file for each enabled module.

string|false
loadInclude(string $module, string $type, string $name = NULL)

Loads a module include file.

array
getHookInfo()

Retrieves a list of hooks that are declared through hook_hook_info().

array
getImplementations(string $hook)

Determines which modules are implementing a hook.

writeCache()

Write the hook implementation info to the cache.

resetImplementations()

Resets the cached list of hook implementations.

bool
implementsHook(string $module, string $hook)

Returns whether a given module implements a given hook.

mixed
invoke(string $module, string $hook, array $args = [])

Invokes a hook in a particular module.

array
invokeAll(string $hook, array $args = [])

Invokes a hook in all enabled modules that implement it.

mixed
invokeDeprecated(string $description, string $module, string $hook, array $args = [])

Invokes a deprecated hook in a particular module.

array
invokeAllDeprecated(string $description, string $hook, array $args = [])

Invokes a deprecated hook in all enabled modules that implement it.

alter(string|array $type, mixed $data, mixed $context1 = NULL, mixed $context2 = NULL)

Passes alterable variables to specific hook_TYPE_alter() implementations.

alterDeprecated(string $description, string|array $type, mixed $data, mixed $context1 = NULL, mixed $context2 = NULL)

Passes alterable variables to deprecated hook_TYPE_alter() implementations.

array
getModuleDirectories()

Returns an array of directories for all enabled modules. Useful for tasks such as finding a file that exists in all module directories.

string
getName(string $module)

Gets the human readable name of a given module.

Details

at line 25
bool load(string $name)

Includes a module's .module file.

This prevents including a module more than once.

Parameters

string $name

The name of the module to load.

Return Value

bool

TRUE if the item is loaded or has already been loaded.

at line 30
loadAll()

Loads all enabled modules.

at line 39
bool isLoaded()

Returns whether all modules have been loaded.

Return Value

bool

A Boolean indicating whether all modules have been loaded. This means all modules; the load status of bootstrap modules cannot be checked.

at line 44
reload()

Reloads all enabled modules.

at line 53
Extension[] getModuleList()

Returns the list of currently active modules.

Return Value

Extension[]

An associative array whose keys are the names of the modules and whose values are Extension objects.

at line 67
Extension getModule(string $name)

Returns a module extension object from the currently active modules list.

Parameters

string $name

The name of the module to return.

Return Value

Extension

An extension object.

Exceptions

UnknownExtensionException

at line 76
setModuleList(array $module_list = [])

Sets an explicit list of currently active modules.

Parameters

array $module_list

An associative array whose keys are the names of the modules and whose values are Extension objects.

at line 86
addModule(string $name, string $path)

Adds a module to the list of currently active modules.

Parameters

string $name

The module name; e.g., 'node'.
string $path

The module path; e.g., 'core/modules/node'.

at line 96
addProfile(string $name, string $path)

Adds an installation profile to the list of currently active modules.

Parameters

string $name

The profile name; e.g., 'standard'.
string $path

The profile path; e.g., 'core/profiles/standard'.

at line 115
The buildModuleDependencies(array $modules)

Determines which modules require and are required by each module.

Parameters

array $modules

An array of module objects keyed by module name. Each object contains information discovered during a Drupal\Core\Extension\ExtensionDiscovery scan.

Return Value

The

same array with the new keys for each module:

  • requires: An array with the keys being the modules that this module requires.
  • required_by: An array with the keys being the modules that will not work without this module.

See also

ExtensionDiscovery

at line 126
bool moduleExists(string $module)

Determines whether a given module is enabled.

Parameters

string $module

The name of the module (without the .module extension).

Return Value

bool

TRUE if the module is both installed and enabled.

at line 137
loadAllIncludes(string $type, string $name = NULL)

Loads an include file for each enabled module.

Parameters

string $type

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

(optional) The base file name (without the $type extension). If omitted, each module's name is used; i.e., "$module.$type" by default.

at line 161
string|false loadInclude(string $module, string $type, string $name = NULL)

Loads a module include file.

Examples:

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.

at line 173
array getHookInfo()

Retrieves a list of hooks that are declared through hook_hook_info().

Return Value

array

An associative array whose keys are hook names and whose values are an associative array containing a group name. The structure of the array is the same as the return value of hook_hook_info().

See also

hook_hook_info()

at line 184
array getImplementations(string $hook)

Determines which modules are implementing a hook.

Parameters

string $hook

The name of the hook (e.g. "help" or "menu").

Return Value

array

An array with the names of the modules which are implementing this hook.

at line 189
writeCache()

Write the hook implementation info to the cache.

at line 194
resetImplementations()

Resets the cached list of hook implementations.

at line 208
bool implementsHook(string $module, string $hook)

Returns whether a given module implements a given hook.

Parameters

string $module

The name of the module (without the .module extension).
string $hook

The name of the hook (e.g. "help" or "menu").

Return Value

bool

TRUE if the module is both installed and enabled, and the hook is implemented in that module.

at line 223
mixed invoke(string $module, string $hook, array $args = [])

Invokes a hook in a particular module.

Parameters

string $module

The name of the module (without the .module extension).
string $hook

The name of the hook to invoke.
array $args

Arguments to pass to the hook implementation.

Return Value

mixed

The return value of the hook implementation.

at line 239
array invokeAll(string $hook, array $args = [])

Invokes a hook in all enabled modules that implement it.

Parameters

string $hook

The name of the hook to invoke.
array $args

Arguments to pass to the hook.

Return Value

array

An array of return values of the hook implementations. If modules return arrays from their implementations, those are merged into one array recursively. Note: integer keys in arrays will be lost, as the merge is done using Drupal\Component\Utility\NestedArray::mergeDeepArray().

at line 265
mixed invokeDeprecated(string $description, string $module, string $hook, array $args = [])

Invokes a deprecated hook in a particular module.

Invoking a deprecated hook adds the behavior of triggering an E_USER_DEPRECATED error if any implementations are found.

API maintainers should use this method instead of invoke() when their hook is deprecated. This method does not detect when a hook is deprecated.

Parameters

string $description

Helpful text describing what to do instead of implementing this hook.
string $module

The name of the module (without the .module extension).
string $hook

The name of the hook to invoke.
array $args

Arguments to pass to the hook implementation.

Return Value

mixed

The return value of the hook implementation.

See also

ModuleHandlerInterface::invoke
https://www.drupal.org/core/deprecation#how-hook

at line 292
array invokeAllDeprecated(string $description, string $hook, array $args = [])

Invokes a deprecated hook in all enabled modules that implement it.

Invoking a deprecated hook adds the behavior of triggering an E_USER_DEPRECATED error if any implementations are found.

API maintainers should use this method instead of invokeAll() when their hook is deprecated. This method does not detect when a hook is deprecated.

Parameters

string $description

Helpful text describing what to do instead of implementing this hook.
string $hook

The name of the hook to invoke.
array $args

Arguments to pass to the hook.

Return Value

array

An array of return values of the hook implementations. If modules return arrays from their implementations, those are merged into one array recursively. Note: integer keys in arrays will be lost, as the merge is done using Drupal\Component\Utility\NestedArray::mergeDeepArray().

See also

ModuleHandlerInterface::invokeAll
https://www.drupal.org/core/deprecation#how-hook

at line 343
alter(string|array $type, mixed $data, mixed $context1 = NULL, mixed $context2 = NULL)

Passes alterable variables to specific hook_TYPE_alter() implementations.

This dispatch function hands off the passed-in variables to type-specific hook_TYPE_alter() implementations in modules. It ensures a consistent interface for all altering operations.

A maximum of 2 alterable arguments is supported. In case more arguments need to be passed and alterable, modules provide additional variables assigned by reference in the last $context argument:

Parameters

string|array $type

A string describing the type of the alterable $data. 'form', 'links', 'node_content', and so on are several examples. Alternatively can be an array, in which case hook_TYPE_alter() is invoked for each value in the array, ordered first by module, and then for each module, in the order of values in $type. For example, when Form API is using $this->alter() to execute both hook_form_alter() and hook_form_FORM_IDalter() implementations, it passes array('form', 'form' . $form_id) for $type.
mixed $data

The variable that will be passed to hook_TYPE_alter() implementations to be altered. The type of this variable depends on the value of the $type argument. For example, when altering a 'form', $data will be a structured array. When altering a 'profile', $data will be an object.
mixed $context1

(optional) An additional variable that is passed by reference.
mixed $context2

(optional) An additional variable that is passed by reference. If more context needs to be provided to implementations, then this should be an associative array as described above.

at line 379
alterDeprecated(string $description, string|array $type, mixed $data, mixed $context1 = NULL, mixed $context2 = NULL)

Passes alterable variables to deprecated hook_TYPE_alter() implementations.

This method triggers an E_USER_DEPRECATED error if any implementations of the alter hook are found. It is otherwise identical to alter().

See the documentation for alter() for more details.

Parameters

string $description

Helpful text describing what to do instead of implementing this alter hook.
string|array $type

A string describing the type of the alterable $data. 'form', 'links', 'node_content', and so on are several examples. Alternatively can be an array, in which case hook_TYPE_alter() is invoked for each value in the array, ordered first by module, and then for each module, in the order of values in $type. For example, when Form API is using $this->alter() to execute both hook_form_alter() and hook_form_FORM_IDalter() implementations, it passes array('form', 'form' . $form_id) for $type.
mixed $data

The variable that will be passed to hook_TYPE_alter() implementations to be altered. The type of this variable depends on the value of the $type argument. For example, when altering a 'form', $data will be a structured array. When altering a 'profile', $data will be an object.
mixed $context1

(optional) An additional variable that is passed by reference.
mixed $context2

(optional) An additional variable that is passed by reference. If more context needs to be provided to implementations, then this should be an associative array as described above.

See also

ModuleHandlerInterface::alter
https://www.drupal.org/core/deprecation#how-hook

at line 387
array getModuleDirectories()

Returns an array of directories for all enabled modules. Useful for tasks such as finding a file that exists in all module directories.

Return Value

array

at line 399
string getName(string $module)

Gets the human readable name of a given module.

Parameters

string $module

The machine name of the module which title should be shown.

Return Value

string

Returns the human readable name of the module or the machine name passed in if no matching module is found.