public function ModuleHandlerInterface::alterDeprecated in Drupal 8

Same name and namespace in other branches

9 core/lib/Drupal/Core/Extension/ModuleHandlerInterface.php \Drupal\Core\Extension\ModuleHandlerInterface::alterDeprecated()

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_ID_alter() 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.

File

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

Class

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

Namespace

Drupal\Core\Extension

Code

public function alterDeprecated($description, $type, &$data, &$context1 = NULL, &$context2 = NULL);

You are here