Provides default content for the Navigation bar.

Return value

array An associative array of navigation block definitions. The following elements should be part of each definition array:

• delta: The expected delta where the block should be placed in the

Navigation bar. Defaults to 0.

• configuration: The key-value array with the Navigation Block definition.

It should include the following elements, besides the Navigation block specific settings:

• id: The Navigation Block plugin ID.
• label: The block label.

-label_display: 0 or 1 depending on whether the label should be displayed or not.

• provider: The module that provides the block. In general, the module

that defines the Navigation block.

Related topics

1 function implements hook_navigation_defaults()

Note: the procedural functions in this list are found by pattern matching, so the list may include some functions that are not actually implementations of this hook.

NavigationTestBlockHooks::navigationDefaults in core/modules/navigation/tests/navigation_test_block/src/Hook/NavigationTestBlockHooks.php

Implements hook_navigation_defaults().

2 invocations of hook_navigation_defaults()

NavigationHooks::modulesInstalled in core/modules/navigation/src/Hook/NavigationHooks.php

Implements hook_modules_installed().

navigation_install in core/modules/navigation/navigation.install

Implements hook_install().

File

core/modules/navigation/navigation.api.php, line 73

Code

function hook_navigation_defaults() : array {
  $blocks = [];
  $blocks[] = [
    'delta' => 1,
    'configuration' => [
      'id' => 'navigation_test',
      'label' => 'My test block',
      'label_display' => 1,
      'provider' => 'navigation_test_block',
      'test_block_setting_foo' => 'Foo',
      'test_block_setting_bar' => 1,
    ],
  ];
  return $blocks;
}

---