navigation.api.php
Hooks related to the Navigation module.
File
-
core/
modules/ navigation/ navigation.api.php
View source
<?php
/**
* @file
* Hooks related to the Navigation module.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Provide content for Navigation content_top section.
*
* @return array
* An associative array of renderable elements.
*
* @see hook_navigation_content_top_alter()
*/
function hook_navigation_content_top() : array {
return [
'navigation_foo' => [
'#markup' => \Drupal::config('system.site')->get('name'),
'#cache' => [
'tags' => [
'config:system.site',
],
],
],
'navigation_bar' => [
'#markup' => 'bar',
],
'navigation_baz' => [
'#markup' => 'baz',
],
];
}
/**
* Alter replacement values for placeholder tokens.
*
* @param $content_top
* An associative array of content returned by hook_navigation_content_top().
*
* @see hook_navigation_content_top()
*/
function hook_navigation_content_top_alter(array &$content_top) : void {
// Remove a specific element.
unset($content_top['navigation_foo']);
// Modify an element.
$content_top['navigation_bar']['#markup'] = 'new bar';
// Change weight.
$content_top['navigation_baz']['#weight'] = '-100';
}
/**
* @} End of "addtogroup hooks".
*/
Functions
Title | Deprecated | Summary |
---|---|---|
hook_navigation_content_top | Provide content for Navigation content_top section. | |
hook_navigation_content_top_alter | Alter replacement values for placeholder tokens. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.