You are here

function hook_domainnav in Domain Access 5

Same name and namespace in other branches
  1. 6.2 API.php \hook_domainnav()
  2. 7.2 domain.api.php \hook_domainnav()

Enables modules to add additional parameters to the $domain array for use by the Domain Navigation module.

Used in cases where custom themes may require extra parameters. This hook is called by domain_nav_render().

Default parameters should not be changed; these are:

  • domain_id -- the unique identifier of this domain
  • subdomain -- the host path of the url for this domain
  • sitename -- the human-readable name of this domain
  • path -- the link path (a Drupal-formatted path)
  • active -- a boolean flag indicating the currently active domain

Related topics

1 invocation of hook_domainnav()
domain_nav_render in domain_nav/domain_nav.module
Renders output for the block.

File

./API.php, line 184
API documentation file.

Code

function hook_domainnav($domain) {
  $extra = array();
  $extra['test'] = 'test';
  return $extra;
}