Function Hook_contentious_overrides_configured->compile_template

Definitions

sources/hooks/systems/contentious_overrides/configured.php

  • Add to a template being compiled.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$data string Yes No required parameter N/A N/A Template data
$template_name ID_TEXT No No required parameter N/A N/A The name of the template (blank: not from a file)
$theme ID_TEXT No No required parameter N/A N/A The name of the theme
$lang ID_TEXT No No required parameter N/A N/A The language it is for
$suffix ?string No No required parameter .tpl .js .xml .txt .css N/A File type suffix of template file (e.g. .tpl) (null: not from a file)
$directory ?string No No required parameter N/A N/A Subdirectory type to look in. Surrounded by '/', unlike with $directory parameters to most other functions (performance reasons) (null: not from a file)

Preview

Code (PHP)

/**
 * Add to a template being compiled.
 *
 * @param  string $data Template data
 * @param  ID_TEXT $template_name The name of the template (blank: not from a file)
 * @param  ID_TEXT $theme The name of the theme
 * @param  ID_TEXT $lang The language it is for
 * @param  ?string $suffix File type suffix of template file (e.g. .tpl) (null: not from a file)
 * @set .tpl .js .xml .txt .css
 * @param  ?string $directory Subdirectory type to look in. Surrounded by '/', unlike with $directory parameters to most other functions (performance reasons) (null: not from a file)
 */
public function compile_template(string &$data, string $template_name, string $theme, string $lang, ?string $suffix, ?string $directory)