Commit d9ab38b2 authored by webchick's avatar webchick

#485350 by jhodgdon: Clarify documentation of module_load_include().

parent b300a7a5
......@@ -138,13 +138,22 @@ function module_load_install($module) {
/**
* Load a module include file.
*
* Examples:
* @code
* // Load node.admin.inc from the node module
* module_load_include('inc', 'node', 'node.admin');
* // Load node.install from the node module
* module_load_include('install', 'node');
* @endcode
*
* @param $type
* The include file's type (file extension).
* @param $module
* The module to which the include file belongs.
* @param $name
* Optionally, specify the file name. If not set, the module's name is used.
* Optionally, specify the base file name (without the $type extension).
* If not set, $module is used.
*/
function module_load_include($type, $module, $name = NULL) {
if (empty($name)) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment