Commit 1a2d10ec authored by Dries's avatar Dries

- Patch #310168 by jhodgdon, arianek, traxer: documentation update.

parent b3b7be43
......@@ -650,17 +650,18 @@ function hook_system_info_alter(&$info, $file) {
* can be selected on the user permissions page and used to grant or restrict
* access to actions the module performs.
*
* @return
* An array of permissions where the permission name is the array key and the
* corresponding key value is an array of key/value pairs specifying
* the permission's title and description
*
* The permissions in the array do not need to be wrapped with the function t(),
* since the string extractor takes care of extracting permission names defined in the perm hook for translation.
*
* Permissions are checked using user_access().
*
* For a detailed usage example, see page_example.module.
*
* @return
* An array of which permission names are the keys and their corresponding
* values are descriptions of each permission.
* The permission names (keys of the array) must not be wrapped with
* the t() function, since the string extractor takes care of
* extracting permission names defined in the perm hook for
* translation. The permission descriptions (values of the array)
* should be wrapped in the t() function so they can be translated.
*/
function hook_permission() {
return array(
......
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