| 1 |
<?php |
<?php |
| 2 |
// $Id: module.inc,v 1.165 2009/11/05 16:19:25 webchick Exp $ |
// $Id: module.inc,v 1.166 2009/11/08 09:29:07 dries Exp $ |
| 3 |
|
|
| 4 |
/** |
/** |
| 5 |
* @file |
* @file |
| 352 |
* Allow modules to interact with the Drupal core. |
* Allow modules to interact with the Drupal core. |
| 353 |
* |
* |
| 354 |
* Drupal's module system is based on the concept of "hooks". A hook is a PHP |
* Drupal's module system is based on the concept of "hooks". A hook is a PHP |
| 355 |
* function that is named foo_bar(), where "foo" is the name of the module (whose |
* function that is named foo_bar(), where "foo" is the name of the module |
| 356 |
* filename is thus foo.module) and "bar" is the name of the hook. Each hook has |
* (whose filename is thus foo.module) and "bar" is the name of the hook. Each |
| 357 |
* a defined set of parameters and a specified result type. |
* hook has a defined set of parameters and a specified result type. |
| 358 |
* |
* |
| 359 |
* To extend Drupal, a module need simply implement a hook. When Drupal wishes to |
* To extend Drupal, a module need simply implement a hook. When Drupal wishes |
| 360 |
* allow intervention from modules, it determines which modules implement a hook |
* to allow intervention from modules, it determines which modules implement a |
| 361 |
* and call that hook in all enabled modules that implement it. |
* hook and calls that hook in all enabled modules that implement it. |
| 362 |
* |
* |
| 363 |
* The available hooks to implement are explained here in the Hooks section of |
* The available hooks to implement are explained here in the Hooks section of |
| 364 |
* the developer documentation. The string "hook" is used as a placeholder for |
* the developer documentation. The string "hook" is used as a placeholder for |
| 365 |
* the module name is the hook definitions. For example, if the module file is |
* the module name in the hook definitions. For example, if the module file is |
| 366 |
* called example.module, then hook_help() as implemented by that module would be |
* called example.module, then hook_help() as implemented by that module would |
| 367 |
* defined as example_help(). |
* be defined as example_help(). |
| 368 |
*/ |
*/ |
| 369 |
|
|
| 370 |
/** |
/** |