Skip navigation
Help

user.api.php

  1. drupal
    1. 7 drupal/modules/user/user.api.php

Hooks provided by the User module.

Functions & methods

NameDescription
hook_user_cancelAct on user account cancellations.
hook_user_cancel_methods_alterModify account cancellation methods.
hook_user_categoriesRetrieve a list of user setting or profile information categories.
hook_user_deleteRespond to user deletion.
hook_user_insertA user account was created.
hook_user_loadAct on user objects when loaded from the database.
hook_user_loginThe user just logged in.
hook_user_logoutThe user just logged out.
hook_user_operationsAdd mass user operations.
hook_user_presaveA user account is about to be created or updated.
hook_user_role_deleteInform other modules that a user role has been deleted.
hook_user_role_insertInform other modules that a user role has been added.
hook_user_role_presaveInform other modules that a user role is about to be saved.
hook_user_role_updateInform other modules that a user role has been updated.
hook_user_updateA user account was updated.
hook_user_viewThe user's account information is being displayed.
hook_user_view_alterThe user was built; the module may modify the structured content.

File

drupal/modules/user/user.api.php
View source
  1. <?php
  2. /**
  3. * @file
  4. * Hooks provided by the User module.
  5. */
  6. /**
  7. * @addtogroup hooks
  8. * @{
  9. */
  10. /**
  11. * Act on user objects when loaded from the database.
  12. *
  13. * Due to the static cache in user_load_multiple() you should not use this
  14. * hook to modify the user properties returned by the {users} table itself
  15. * since this may result in unreliable results when loading from cache.
  16. *
  17. * @param $users
  18. * An array of user objects, indexed by uid.
  19. *
  20. * @see user_load_multiple()
  21. * @see profile_user_load()
  22. */
  23. function hook_user_load($users) {
  24. $result = db_query('SELECT uid, foo FROM {my_table} WHERE uid IN (:uids)', array(':uids' => array_keys($users)));
  25. foreach ($result as $record) {
  26. $users[$record->uid]->foo = $record->foo;
  27. }
  28. }
  29. /**
  30. * Respond to user deletion.
  31. *
  32. * This hook is invoked from user_delete_multiple() before field_attach_delete()
  33. * is called and before users are actually removed from the database.
  34. *
  35. * Modules should additionally implement hook_user_cancel() to process stored
  36. * user data for other account cancellation methods.
  37. *
  38. * @param $account
  39. * The account that is being deleted.
  40. *
  41. * @see user_delete_multiple()
  42. */
  43. function hook_user_delete($account) {
  44. db_delete('mytable')
  45. ->condition('uid', $account->uid)
  46. ->execute();
  47. }
  48. /**
  49. * Act on user account cancellations.
  50. *
  51. * This hook is invoked from user_cancel() before a user account is canceled.
  52. * Depending on the account cancellation method, the module should either do
  53. * nothing, unpublish content, or anonymize content. See user_cancel_methods()
  54. * for the list of default account cancellation methods provided by User module.
  55. * Modules may add further methods via hook_user_cancel_methods_alter().
  56. *
  57. * This hook is NOT invoked for the 'user_cancel_delete' account cancellation
  58. * method. To react on this method, implement hook_user_delete() instead.
  59. *
  60. * Expensive operations should be added to the global account cancellation batch
  61. * by using batch_set().
  62. *
  63. * @param $edit
  64. * The array of form values submitted by the user.
  65. * @param $account
  66. * The user object on which the operation is being performed.
  67. * @param $method
  68. * The account cancellation method.
  69. *
  70. * @see user_cancel_methods()
  71. * @see hook_user_cancel_methods_alter()
  72. */
  73. function hook_user_cancel($edit, $account, $method) {
  74. switch ($method) {
  75. case 'user_cancel_block_unpublish':
  76. // Unpublish nodes (current revisions).
  77. module_load_include('inc', 'node', 'node.admin');
  78. $nodes = db_select('node', 'n')
  79. ->fields('n', array('nid'))
  80. ->condition('uid', $account->uid)
  81. ->execute()
  82. ->fetchCol();
  83. node_mass_update($nodes, array('status' => 0));
  84. break;
  85. case 'user_cancel_reassign':
  86. // Anonymize nodes (current revisions).
  87. module_load_include('inc', 'node', 'node.admin');
  88. $nodes = db_select('node', 'n')
  89. ->fields('n', array('nid'))
  90. ->condition('uid', $account->uid)
  91. ->execute()
  92. ->fetchCol();
  93. node_mass_update($nodes, array('uid' => 0));
  94. // Anonymize old revisions.
  95. db_update('node_revision')
  96. ->fields(array('uid' => 0))
  97. ->condition('uid', $account->uid)
  98. ->execute();
  99. // Clean history.
  100. db_delete('history')
  101. ->condition('uid', $account->uid)
  102. ->execute();
  103. break;
  104. }
  105. }
  106. /**
  107. * Modify account cancellation methods.
  108. *
  109. * By implementing this hook, modules are able to add, customize, or remove
  110. * account cancellation methods. All defined methods are turned into radio
  111. * button form elements by user_cancel_methods() after this hook is invoked.
  112. * The following properties can be defined for each method:
  113. * - title: The radio button's title.
  114. * - description: (optional) A description to display on the confirmation form
  115. * if the user is not allowed to select the account cancellation method. The
  116. * description is NOT used for the radio button, but instead should provide
  117. * additional explanation to the user seeking to cancel their account.
  118. * - access: (optional) A boolean value indicating whether the user can access
  119. * a method. If #access is defined, the method cannot be configured as default
  120. * method.
  121. *
  122. * @param $methods
  123. * An array containing user account cancellation methods, keyed by method id.
  124. *
  125. * @see user_cancel_methods()
  126. * @see user_cancel_confirm_form()
  127. */
  128. function hook_user_cancel_methods_alter(&$methods) {
  129. // Limit access to disable account and unpublish content method.
  130. $methods['user_cancel_block_unpublish']['access'] = user_access('administer site configuration');
  131. // Remove the content re-assigning method.
  132. unset($methods['user_cancel_reassign']);
  133. // Add a custom zero-out method.
  134. $methods['mymodule_zero_out'] = array(
  135. 'title' => t('Delete the account and remove all content.'),
  136. 'description' => t('All your content will be replaced by empty strings.'),
  137. // access should be used for administrative methods only.
  138. 'access' => user_access('access zero-out account cancellation method'),
  139. );
  140. }
  141. /**
  142. * Add mass user operations.
  143. *
  144. * This hook enables modules to inject custom operations into the mass operations
  145. * dropdown found at admin/people, by associating a callback function with
  146. * the operation, which is called when the form is submitted. The callback function
  147. * receives one initial argument, which is an array of the checked users.
  148. *
  149. * @return
  150. * An array of operations. Each operation is an associative array that may
  151. * contain the following key-value pairs:
  152. * - "label": Required. The label for the operation, displayed in the dropdown menu.
  153. * - "callback": Required. The function to call for the operation.
  154. * - "callback arguments": Optional. An array of additional arguments to pass to
  155. * the callback function.
  156. *
  157. */
  158. function hook_user_operations() {
  159. $operations = array(
  160. 'unblock' => array(
  161. 'label' => t('Unblock the selected users'),
  162. 'callback' => 'user_user_operations_unblock',
  163. ),
  164. 'block' => array(
  165. 'label' => t('Block the selected users'),
  166. 'callback' => 'user_user_operations_block',
  167. ),
  168. 'cancel' => array(
  169. 'label' => t('Cancel the selected user accounts'),
  170. ),
  171. );
  172. return $operations;
  173. }
  174. /**
  175. * Retrieve a list of user setting or profile information categories.
  176. *
  177. * @return
  178. * An array of associative arrays. Each inner array has elements:
  179. * - "name": The internal name of the category.
  180. * - "title": The human-readable, localized name of the category.
  181. * - "weight": An integer specifying the category's sort ordering.
  182. * - "access callback": Name of the access callback function to use to
  183. * determine whether the user can edit the category. Defaults to using
  184. * user_edit_access(). See hook_menu() for more information on access
  185. * callbacks.
  186. * - "access arguments": Arguments for the access callback function. Defaults
  187. * to array(1).
  188. */
  189. function hook_user_categories() {
  190. return array(array(
  191. 'name' => 'account',
  192. 'title' => t('Account settings'),
  193. 'weight' => 1,
  194. ));
  195. }
  196. /**
  197. * A user account is about to be created or updated.
  198. *
  199. * This hook is primarily intended for modules that want to store properties in
  200. * the serialized {users}.data column, which is automatically loaded whenever a
  201. * user account object is loaded, modules may add to $edit['data'] in order
  202. * to have their data serialized on save.
  203. *
  204. * @param $edit
  205. * The array of form values submitted by the user.
  206. * @param $account
  207. * The user object on which the operation is performed.
  208. * @param $category
  209. * The active category of user information being edited.
  210. *
  211. * @see hook_user_insert()
  212. * @see hook_user_update()
  213. */
  214. function hook_user_presave(&$edit, $account, $category) {
  215. // Make sure that our form value 'mymodule_foo' is stored as 'mymodule_bar'.
  216. if (isset($edit['mymodule_foo'])) {
  217. $edit['data']['my_module_foo'] = $edit['my_module_foo'];
  218. }
  219. }
  220. /**
  221. * A user account was created.
  222. *
  223. * The module should save its custom additions to the user object into the
  224. * database.
  225. *
  226. * @param $edit
  227. * The array of form values submitted by the user.
  228. * @param $account
  229. * The user object on which the operation is being performed.
  230. * @param $category
  231. * The active category of user information being edited.
  232. *
  233. * @see hook_user_presave()
  234. * @see hook_user_update()
  235. */
  236. function hook_user_insert(&$edit, $account, $category) {
  237. db_insert('mytable')
  238. ->fields(array(
  239. 'myfield' => $edit['myfield'],
  240. 'uid' => $account->uid,
  241. ))
  242. ->execute();
  243. }
  244. /**
  245. * A user account was updated.
  246. *
  247. * Modules may use this hook to update their user data in a custom storage
  248. * after a user account has been updated.
  249. *
  250. * @param $edit
  251. * The array of form values submitted by the user.
  252. * @param $account
  253. * The user object on which the operation is performed.
  254. * @param $category
  255. * The active category of user information being edited.
  256. *
  257. * @see hook_user_presave()
  258. * @see hook_user_insert()
  259. */
  260. function hook_user_update(&$edit, $account, $category) {
  261. db_insert('user_changes')
  262. ->fields(array(
  263. 'uid' => $account->uid,
  264. 'changed' => time(),
  265. ))
  266. ->execute();
  267. }
  268. /**
  269. * The user just logged in.
  270. *
  271. * @param $edit
  272. * The array of form values submitted by the user.
  273. * @param $account
  274. * The user object on which the operation was just performed.
  275. */
  276. function hook_user_login(&$edit, $account) {
  277. // If the user has a NULL time zone, notify them to set a time zone.
  278. if (!$account->timezone && variable_get('configurable_timezones', 1) && variable_get('empty_timezone_message', 0)) {
  279. drupal_set_message(t('Configure your <a href="@user-edit">account time zone setting</a>.', array('@user-edit' => url("user/$account->uid/edit", array('query' => drupal_get_destination(), 'fragment' => 'edit-timezone')))));
  280. }
  281. }
  282. /**
  283. * The user just logged out.
  284. *
  285. * @param $account
  286. * The user object on which the operation was just performed.
  287. */
  288. function hook_user_logout($account) {
  289. db_insert('logouts')
  290. ->fields(array(
  291. 'uid' => $account->uid,
  292. 'time' => time(),
  293. ))
  294. ->execute();
  295. }
  296. /**
  297. * The user's account information is being displayed.
  298. *
  299. * The module should format its custom additions for display and add them to the
  300. * $account->content array.
  301. *
  302. * @param $account
  303. * The user object on which the operation is being performed.
  304. * @param $view_mode
  305. * View mode, e.g. 'full'.
  306. * @param $langcode
  307. * The language code used for rendering.
  308. *
  309. * @see hook_user_view_alter()
  310. * @see hook_entity_view()
  311. */
  312. function hook_user_view($account, $view_mode, $langcode) {
  313. if (user_access('create blog content', $account)) {
  314. $account->content['summary']['blog'] = array(
  315. '#type' => 'user_profile_item',
  316. '#title' => t('Blog'),
  317. '#markup' => l(t('View recent blog entries'), "blog/$account->uid", array('attributes' => array('title' => t("Read !username's latest blog entries.", array('!username' => format_username($account)))))),
  318. '#attributes' => array('class' => array('blog')),
  319. );
  320. }
  321. }
  322. /**
  323. * The user was built; the module may modify the structured content.
  324. *
  325. * This hook is called after the content has been assembled in a structured array
  326. * and may be used for doing processing which requires that the complete user
  327. * content structure has been built.
  328. *
  329. * If the module wishes to act on the rendered HTML of the user rather than the
  330. * structured content array, it may use this hook to add a #post_render callback.
  331. * Alternatively, it could also implement hook_preprocess_user_profile(). See
  332. * drupal_render() and theme() documentation respectively for details.
  333. *
  334. * @param $build
  335. * A renderable array representing the user.
  336. *
  337. * @see user_view()
  338. * @see hook_entity_view_alter()
  339. */
  340. function hook_user_view_alter(&$build) {
  341. // Check for the existence of a field added by another module.
  342. if (isset($build['an_additional_field'])) {
  343. // Change its weight.
  344. $build['an_additional_field']['#weight'] = -10;
  345. }
  346. // Add a #post_render callback to act on the rendered HTML of the user.
  347. $build['#post_render'][] = 'my_module_user_post_render';
  348. }
  349. /**
  350. * Inform other modules that a user role is about to be saved.
  351. *
  352. * Modules implementing this hook can act on the user role object before
  353. * it has been saved to the database.
  354. *
  355. * @param $role
  356. * A user role object.
  357. *
  358. * @see hook_user_role_insert()
  359. * @see hook_user_role_update()
  360. */
  361. function hook_user_role_presave($role) {
  362. // Set a UUID for the user role if it doesn't already exist
  363. if (empty($role->uuid)) {
  364. $role->uuid = uuid_uuid();
  365. }
  366. }
  367. /**
  368. * Inform other modules that a user role has been added.
  369. *
  370. * Modules implementing this hook can act on the user role object when saved to
  371. * the database. It's recommended that you implement this hook if your module
  372. * adds additional data to user roles object. The module should save its custom
  373. * additions to the database.
  374. *
  375. * @param $role
  376. * A user role object.
  377. */
  378. function hook_user_role_insert($role) {
  379. // Save extra fields provided by the module to user roles.
  380. db_insert('my_module_table')
  381. ->fields(array(
  382. 'rid' => $role->rid,
  383. 'role_description' => $role->description,
  384. ))
  385. ->execute();
  386. }
  387. /**
  388. * Inform other modules that a user role has been updated.
  389. *
  390. * Modules implementing this hook can act on the user role object when updated.
  391. * It's recommended that you implement this hook if your module adds additional
  392. * data to user roles object. The module should save its custom additions to
  393. * the database.
  394. *
  395. * @param $role
  396. * A user role object.
  397. */
  398. function hook_user_role_update($role) {
  399. // Save extra fields provided by the module to user roles.
  400. db_merge('my_module_table')
  401. ->key(array('rid' => $role->rid))
  402. ->fields(array(
  403. 'role_description' => $role->description
  404. ))
  405. ->execute();
  406. }
  407. /**
  408. * Inform other modules that a user role has been deleted.
  409. *
  410. * This hook allows you act when a user role has been deleted.
  411. * If your module stores references to roles, it's recommended that you
  412. * implement this hook and delete existing instances of the deleted role
  413. * in your module database tables.
  414. *
  415. * @param $role
  416. * The $role object being deleted.
  417. */
  418. function hook_user_role_delete($role) {
  419. // Delete existing instances of the deleted role.
  420. db_delete('my_module_table')
  421. ->condition('rid', $role->rid)
  422. ->execute();
  423. }
  424. /**
  425. * @} End of "addtogroup hooks".
  426. */