User login
Navigation
More Information
hook_domainload
Definition
hook_domainload(&$domain)
API.php, line 100
Description
Notifies other modules that we are loading a domain record from the database.
Modules may overwrite or add to the $domain array for each subdomain.
WARNING: If you need to make revisions to the $_domain global before it is processed by other modules, you must implement hook_init(). Only modules that implement hook_init() are loaded during the creation routine for the $_domain global. If your module has not been loaded, then hook_domainload() will skip your implementation.
When loading lists of domains or generating domain information, either use the proper functions -- domain_default(), domain_lookup(), and domain_domains() -- or invoke this hook.
Invoked by domain_lookup() and domain_default().
Parameters
&$domain The current $domain array.
Return value
No return value. The $domain array is modified by reference..
Related topics
Name | Description |
|---|---|
| Domain hook functions | Core hooks for the Domain module suite. |
Code
function hook_domainload(&$domain) {
// Add a variable to the $domain array.
$domain['myvar'] = 'mydomainvar';
// Remove the site_grant flag, making it so users can't see content for 'all affiliates.'
$domain['site_grant'] = FALSE;
}