function hook_theme_registry_alter in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Render/theme.api.php \hook_theme_registry_alter()
2. 7 modules/system/system.api.php \hook_theme_registry_alter()

Alter the theme registry information returned from hook_theme().

The theme registry stores information about all available theme hooks, including which callback functions those hooks will call when triggered, what template files are exposed by these hooks, and so on.

Note that this hook is only executed as the theme cache is re-built. Changes here will not be visible until the next cache clear.

The $theme_registry array is keyed by theme hook name, and contains the information returned from hook_theme(), as well as additional properties added by \Drupal\Core\Theme\Registry::processExtension().

For example:

$theme_registry['block_content_add_list'] = array(
  'template' => 'block-content-add-list',
  'path' => 'core/themes/seven/templates',
  'type' => 'theme_engine',
  'theme path' => 'core/themes/seven',
  'includes' => array(
    0 => 'core/modules/block_content/block_content.pages.inc',
  ),
  'variables' => array(
    'content' => NULL,
  ),
  'preprocess functions' => array(
    0 => 'template_preprocess',
    1 => 'template_preprocess_block_content_add_list',
    2 => 'contextual_preprocess',
    3 => 'seven_preprocess_block_content_add_list',
  ),
);

Parameters

$theme_registry: The entire cache of theme registry information, post-processing.

See also

hook_theme()

\Drupal\Core\Theme\Registry::processExtension()

Related topics

5 functions implement hook_theme_registry_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

claro_system_module_invoked_theme_registry_alter in core/themes/claro/claro.theme

Called by system.module via its hook_theme_registry_alter().

claro_theme_registry_alter in core/themes/claro/claro.theme

Implements hook_theme_registry_alter().

layout_builder_theme_registry_alter in core/modules/layout_builder/layout_builder.module

Implements hook_theme_registry_alter().

system_theme_registry_alter in core/modules/system/system.module

Implements hook_theme_registry_alter().

test_theme_theme_registry_alter in core/modules/system/tests/themes/test_theme/test_theme.theme

Implements hook_theme_registry_alter().

1 invocation of hook_theme_registry_alter()

Registry::build in core/lib/Drupal/Core/Theme/Registry.php

Builds the theme registry cache.

File

core/lib/Drupal/Core/Render/theme.api.php, line 1280

Hooks and documentation related to the theme and render system.

Code

function hook_theme_registry_alter(&$theme_registry) {

  // Kill the next/previous forum topic navigation links.
  foreach ($theme_registry['forum_topic_navigation']['preprocess functions'] as $key => $value) {
    if ($value == 'template_preprocess_forum_topic_navigation') {
      unset($theme_registry['forum_topic_navigation']['preprocess functions'][$key]);
    }
  }
}