1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Theme
  7. \
  8. ThemeInitializationInterface

ThemeInitializationInterface

interface ThemeInitializationInterface (View source)

Defines an interface which contain theme initialization logic.

Methods

ActiveTheme
initTheme(string $theme_name)

Initializes a given theme.

ActiveTheme
getActiveThemeByName(string $theme_name)

Builds an active theme object.

loadActiveTheme(ActiveTheme $active_theme)

Loads a theme, so it is ready to be used.

ActiveTheme
getActiveTheme(Extension $theme, array $base_themes = [])

Builds up the active theme object from extensions.

Details

at line 23
ActiveTheme initTheme(string $theme_name)

Initializes a given theme.

This loads the active theme, for example include its engine file.

Parameters

string $theme_name

The machine name of the theme.

Return Value

ActiveTheme

An active theme object instance for the given theme.

at line 37
ActiveTheme getActiveThemeByName(string $theme_name)

Builds an active theme object.

Parameters

string $theme_name

The machine name of the theme.

Return Value

ActiveTheme

An active theme object instance for the given theme.

Exceptions

MissingThemeDependencyException

at line 48
loadActiveTheme(ActiveTheme $active_theme)

Loads a theme, so it is ready to be used.

Loading a theme includes loading and initializing the engine, each base theme and its engines.

Parameters

ActiveTheme $active_theme

The theme to load.

at line 62
ActiveTheme getActiveTheme(Extension $theme, array $base_themes = [])

Builds up the active theme object from extensions.

Parameters

Extension $theme

The theme extension object.
array $base_themes

An array of extension objects of base theme and its bases. It is ordered by 'next parent first', meaning the top level of the chain will be first.

Return Value

ActiveTheme

The active theme instance for the passed in $theme.