function system_token_info
Same name in other branches
- 7.x modules/system/system.tokens.inc \system_token_info()
- 8.9.x core/modules/system/system.tokens.inc \system_token_info()
- 10 core/modules/system/system.tokens.inc \system_token_info()
- 11.x core/modules/system/system.tokens.inc \system_token_info()
Implements hook_token_info().
File
-
core/
modules/ system/ system.tokens.inc, line 17
Code
function system_token_info() {
$types['site'] = [
'name' => t("Site information"),
'description' => t("Tokens for site-wide settings and other global information."),
];
$types['date'] = [
'name' => t("Dates"),
'description' => t("Tokens related to times and dates."),
];
// Site-wide global tokens.
$site['name'] = [
'name' => t("Name"),
'description' => t("The name of the site."),
];
$site['slogan'] = [
'name' => t("Slogan"),
'description' => t("The slogan of the site."),
];
$site['mail'] = [
'name' => t("Email"),
'description' => t("The administrative email address for the site."),
];
$site['url'] = [
'name' => t("URL"),
'description' => t("The URL of the site's front page."),
];
$site['url-brief'] = [
'name' => t("URL (brief)"),
'description' => t("The URL of the site's front page without the protocol."),
];
$site['login-url'] = [
'name' => t("Login page"),
'description' => t("The URL of the site's login page."),
];
/** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
$date_formatter = \Drupal::service('date.formatter');
// Date related tokens.
$request_time = \Drupal::time()->getRequestTime();
$date['short'] = [
'name' => t("Short format"),
'description' => t("A date in 'short' format. (%date)", [
'%date' => $date_formatter->format($request_time, 'short'),
]),
];
$date['medium'] = [
'name' => t("Medium format"),
'description' => t("A date in 'medium' format. (%date)", [
'%date' => $date_formatter->format($request_time, 'medium'),
]),
];
$date['long'] = [
'name' => t("Long format"),
'description' => t("A date in 'long' format. (%date)", [
'%date' => $date_formatter->format($request_time, 'long'),
]),
];
$date['custom'] = [
'name' => t("Custom format"),
'description' => t('A date in a custom format. See <a href="https://www.php.net/manual/datetime.format.php#refsect1-datetime.format-parameters">the PHP documentation</a> for details.'),
];
$date['since'] = [
'name' => t("Time-since"),
'description' => t("A date in 'time-since' format. (%date)", [
'%date' => $date_formatter->formatTimeDiffSince($request_time - 360),
]),
];
$date['raw'] = [
'name' => t("Raw timestamp"),
'description' => t("A date in UNIX timestamp format (%date)", [
'%date' => $request_time,
]),
];
return [
'types' => $types,
'tokens' => [
'site' => $site,
'date' => $date,
],
];
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.