module.inc 6.53 KB
Newer Older
1
2
3
<?php
// $Id$

4
5
6
7
8
/**
 * @file
 * API for loading and interacting with Drupal modules.
 */

9
/**
10
 * Load all the modules that have been enabled in the system table.
11
 */
12
function module_load_all() {
13
14
15
  foreach (module_list(TRUE, FALSE) as $module) {
    drupal_load('module', $module);
  }
16
17
}

18
19
20
21
/**
 * Call a function repeatedly with each module in turn as an argument.
 */
function module_iterate($function, $argument = '') {
Kjartan's avatar
Kjartan committed
22
23
24
  foreach (module_list() as $name) {
    $function($name, $argument);
  }
25
26
}

27
/**
28
29
 * Collect a list of all loaded modules. During the bootstrap, return only
 * vital modules. See bootstrap.inc
30
31
32
33
34
 *
 * @param $refresh
 *   Whether to force the module list to be regenerated (such as after the
 *   administrator has changed the system settings).
 * @param $bootstrap
35
36
 *   Whether to return the reduced set of modules loaded in "bootstrap mode"
 *   for cached pages. See bootstrap.inc.
37
38
39
 * @param $sort
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
40
41
42
43
 * @return
 *   An associative array whose keys and values are the names of all loaded
 *   modules.
 */
44
45
function module_list($refresh = FALSE, $bootstrap = TRUE, $sort = FALSE) {
  static $list, $sorted_list;
46

Dries's avatar
   
Dries committed
47
  if ($refresh) {
48
    unset($sorted_list);
Dries's avatar
Dries committed
49
    $list = array();
50
    if ($bootstrap) {
51
      $result = db_query("SELECT name, filename, throttle, bootstrap FROM {system} WHERE type = 'module' AND status = 1 AND bootstrap = 1 ORDER BY weight ASC, filename ASC");
52
53
    }
    else {
54
      $result = db_query("SELECT name, filename, throttle, bootstrap FROM {system} WHERE type = 'module' AND status = 1 ORDER BY weight ASC, filename ASC");
55
    }
56
    while ($module = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
57
      if (file_exists($module->filename)) {
58
59
60
        // 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.
61
        $throttle = ($module->throttle && variable_get('throttle_level', 0) > 0);
62
        if (!$throttle) {
Dries's avatar
Dries committed
63
          drupal_get_filename('module', $module->name, $module->filename);
Dries's avatar
   
Dries committed
64
65
          $list[$module->name] = $module->name;
        }
66
      }
67
68
    }
  }
69
70
71
72
73
74
75
  if ($sort) {
    if (!isset($sorted_list)) {
      $sorted_list = $list;
      ksort($sorted_list);
    }
    return $sorted_list;
  }
76
77
78
  return $list;
}

79
80
81
82
83
84
85
86
87
/**
 * 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) {
88
  $list = module_list();
89
  return array_key_exists($module, $list);
90
91
}

92
93
/**
 * @defgroup hooks Hooks
Dries's avatar
   
Dries committed
94
95
 * @{
 * Allow modules to interact with the Drupal core.
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 *
 * 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);
126
127
}

Dries's avatar
   
Dries committed
128
129
130
131
132
/**
 * Determine which modules are implementing a hook.
 *
 * @param $hook
 *   The name of the hook (e.g. "help" or "menu").
133
134
135
 * @param $sort
 *   By default, modules are ordered by weight and filename, settings this option
 *   to TRUE, module list will be ordered by module name.
Dries's avatar
   
Dries committed
136
137
138
 * @return
 *   An array with the names of the modules which are implementing this hook.
 */
139
function module_implements($hook, $sort = FALSE) {
Dries's avatar
   
Dries committed
140
141
142
143
  static $implementations;

  if (!isset($implementations[$hook])) {
    $implementations[$hook] = array();
144
    $list = module_list(FALSE, TRUE, $sort);
Dries's avatar
   
Dries committed
145
146
147
148
149
150
151
    foreach ($list as $module) {
      if (module_hook($module, $hook)) {
        $implementations[$hook][] = $module;
      }
    }
  }

152
  // The explicit cast forces a copy to be made. This is needed because
153
154
155
156
157
158
  // $implementations[$hook] is only a reference to an element of
  // $implementations and if there are nested foreaches (due to nested node
  // API calls, for example), they would both manipulate the same array's
  // references, which causes some modules' hooks not to be called.
  // See also http://www.zend.com/zend/art/ref-count.php.
  return (array)$implementations[$hook];
Dries's avatar
   
Dries committed
159
160
}

161
162
163
164
165
166
167
168
169
170
171
172
/**
 * 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.
 */
173
174
175
176
function module_invoke() {
  $args = func_get_args();
  $module = array_shift($args);
  $hook = array_shift($args);
177
  $function = $module .'_'. $hook;
178
179
  if (module_hook($module, $hook)) {
    return call_user_func_array($function, $args);
180
181
182
183
184
185
186
187
188
189
190
191
192
  }
}
/**
 * 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.
 */
193
194
195
function module_invoke_all() {
  $args = func_get_args();
  $hook = array_shift($args);
196
  $return = array();
197
198
199
  foreach (module_implements($hook) as $module) {
    $function = $module .'_'. $hook;
    $result = call_user_func_array($function, $args);
200
    if (isset($result) && is_array($result)) {
201
202
      $return = array_merge($return, $result);
    }
203
204
205
    else if (isset($result)) {
      $return[] = $result;
    }
206
207
208
209
210
211
  }

  return $return;
}

/**
Dries's avatar
   
Dries committed
212
 * @} End of "defgroup hooks".
213
214
 */

215