Newer
Older
/**
* @file
* API for loading and interacting with Drupal modules.
*/
/**
* Initialize all modules.
*
*/
function module_init() {
Dries Buytaert
committed
module_invoke_all('init');
/**
* Call a function repeatedly with each module in turn as an argument.
*/
function module_iterate($function, $argument = '') {
foreach (module_list() as $name) {
$function($name, $argument);
}
/**
* Collect a list of all installed and enabled modules.
*
* @param $refresh
* Whether to force the module list to be regenerated (such as after the
* administrator has changed the system settings).
* @param $bootstrap
* Whether to return the reduced set of modules loaded in "bootstrap mode" for
* cached pages. See bootstrap.inc.
* @return
* An associative array whose keys and values are the names of all loaded
* modules.
*/
function module_list($refresh = FALSE, $bootstrap = FALSE) {
$list = array('admin' => 'admin', 'filter' => 'filter', 'system' => 'system', 'user' => 'user', 'watchdog' => 'watchdog');
if ($bootstrap) {
$result = db_query("SELECT name, filename, throttle, bootstrap FROM {system} WHERE type = 'module' AND status = 1 AND bootstrap = 1");
}
else {
$result = db_query("SELECT name, filename, throttle, bootstrap FROM {system} WHERE type = 'module' AND status = 1");
}
while ($module = db_fetch_object($result)) {
// Determine the current throttle status and see if the module should be
// loaded based on server load. We have to directly access the throttle
// variables, since throttle.module may not be loaded yet.
$throttle = ($module->throttle && variable_get('throttle_level', 0) > 4);
if (!$throttle) {
}
return $list;
}
/**
* Set the filename of a module, for future loading through module_load()
*
* @param $module
* Name of the module which to specify the filename of.
* @param $pa
* Filename of the module named $module.
* @return
* Filename of module, if no $path has been specified.
*/
function module_set_filename($module, $path = null) {
static $list;
if ($path) {
$list[$module] = $path;
}
else {
Dries Buytaert
committed
return array_key_exists($module, $list) ? $list[$module] : "modules/$module.module";
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
}
}
/**
* Retrieve the filename of a module
*
* @param $module
* Name of the module which to retrieve the filename of.
* @return
* Filename of module.
*/
function module_get_filename($module) {
return module_set_filename($module);
}
/**
* Retrieve the path of a module
*
* @param $module
* Name of the module which to retrieve the path of.
* @return
* Path of module.
*/
function module_get_path($module) {
return dirname(module_get_filename($module));
}
/**
* Load a module into Drupal, but check first whether a module by the same name
* has been loaded, and that the filename being included exists.
* @param $module
* The name of the module to be loaded.
* @return
*/
function module_load($module) {
static $loaded = array();
Dries Buytaert
committed
if (!array_key_exists($module, $loaded)) {
$filename = module_get_filename($module);
if (file_exists($filename)) {
include_once($filename);
$loaded[$module] = $filename;
return true;
}
}
return false;
}
/**
* Load all the modules that have been enabled in the system table.
*
* @return
* TRUE if all modules were loaded successfully
*/
function module_load_all() {
Dries Buytaert
committed
$list = module_list(TRUE, FALSE);
Dries Buytaert
committed
$status &= module_load($module);
/**
* Determine whether a given module exists.
*
* @param $module
* The name of the module (without the .module extension).
* @return
* TRUE if the module is both installed and enabled.
*/
function module_exist($module) {
$list = module_list();
return array_key_exists($module, $list);
/**
* @defgroup hooks Hooks
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
*
* Drupal's module system is based on the concept of "hooks". A hook is a PHP
* function that is named foo_bar(), where "foo" is the name of the module (whose
* filename is thus foo.module) and "bar" is the name of the hook. Each hook has
* a defined set of parameters and a specified result type.
*
* To extend Drupal, a module need simply implement a hook. When Drupal wishes to
* allow intervention from modules, it determines which modules implement a hook
* and call that hook in all enabled modules that implement it.
*
* The available hooks to implement are explained here in the Hooks section of
* the developer documentation. The string "hook" is used as a placeholder for
* the module name is the hook definitions. For example, if the module file is
* called example.module, then hook_help() as implemented by that module would be
* defined as example_help().
*/
/**
* Determine whether a module implements a hook.
*
* @param $module
* The name of the module (without the .module extension).
* @param $hook
* The name of the hook (e.g. "help" or "menu").
* @return
* TRUE if the module is both installed and enabled, and the hook is
* implemented in that module.
*/
function module_hook($module, $hook) {
return function_exists($module .'_'. $hook);
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/**
* Invoke a hook in a particular module.
*
* @param $module
* The name of the module (without the .module extension).
* @param $hook
* The name of the hook to invoke.
* @param ...
* Arguments to pass to the hook implementation.
* @return
* The return value of the hook implementation.
*/
function module_invoke($module, $hook, $a1 = NULL, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
$function = $module .'_'. $hook;
if (function_exists($function)) {
return $function($a1, $a2, $a3, $a4);
}
}
/**
* Invoke a hook in all enabled modules that implement it.
*
* @param $hook
* The name of the hook to invoke.
* @param ...
* Arguments to pass to the hook.
* @return
* An array of return values of the hook implementations. If modules return
* arrays from their implementations, those are merged into one array.
*/
function module_invoke_all($hook, $a1 = NULL, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
$return = array();
foreach (module_list() as $module) {
$result = module_invoke($module, $hook, $a1, $a2, $a3, $a4);
Steven Wittens
committed
if (is_array($result)) {
$return = array_merge($return, $result);
}
Steven Wittens
committed
else if (isset($result)) {
$return[] = $result;
}
}
return $return;
}
/**