function hook_theme_registry_alter

You are here

7 system.api.php hook_theme_registry_alter(&$theme_registry)
6 core.php hook_theme_registry_alter(&$theme_registry)
8 system.api.php hook_theme_registry_alter(&$theme_registry)

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

For example:

$theme_registry['user_profile'] = array(
  'variables' => array(
    'account' => NULL,
  ),
  'template' => 'modules/user/user-profile',
  'file' => 'modules/user/user.pages.inc',
  'type' => 'module',
  'theme path' => 'modules/user',
  'preprocess functions' => array(
    0 => 'template_preprocess',
    1 => 'template_preprocess_user_profile',
  ),
);

Parameters

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

See also

hook_theme()

_theme_process_registry()

Related topics

1 invocation of hook_theme_registry_alter()
_theme_build_registry in includes/theme.inc
Builds the theme registry cache.

File

modules/system/system.api.php, line 2282
Hooks provided by Drupal core and the System module.

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]);
    }
  }
}

Comments

How do you implement changes to only specific pages? I've implemented this function in a custom module, but it is effecting every page in my site, which is not the intent.

This function is fired once to build everything for all themes on all pages. If you want to modify a theme for some pages, I suggest you set up a subtheme for those pages and use something like the themekey module to show the subtheme on the special pages. You can then alter the subtheme.

In hook_theme(), specifying the 'file' parameter will automatically prefix the right base path or your own specified base path to this file using 'path'. This is done before hook_theme_registry_alter(), so rather than supplying these, append the full path to the 'includes' parameter.

eg:

<?php
function base_theme_registry_alter(&$theme_registry) {
 
$path = drupal_get_path('module', 'base');
 
// Override the content type summary info.
 
if (isset($theme_registry['node_admin_overview'])) {
   
// This is how it is done in hook_theme(), but it does not work here.
    // $theme_registry['node_admin_overview']['file'] = 'node_admin_overview.inc';
    // $theme_registry['node_admin_overview']['path'] = $path . '/theme';

   

$theme_registry['node_admin_overview']['includes'][] = $path . '/theme/node_admin_overview.inc';
   
$theme_registry['node_admin_overview']['function'] = 'base_node_admin_overview';
  }
}
?>