realname.api.php 950 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. <?php
  2. /**
  3. * @file
  4. * Hooks provided by the Real name module.
  5. */
  6. /**
  7. * @addtogroup hooks
  8. * @{
  9. */
  10. /**
  11. * Alter the pattern for a user's real name prior to generation.
  12. *
  13. * @param string $pattern
  14. * The real name pattern string prior to token replacement.
  15. * @param object $account
  16. * A user account object.
  17. *
  18. * @see realname_update()
  19. *
  20. * @ingroup realname
  21. */
  22. function hook_realname_pattern_alter(&$pattern, $account) {
  23. }
  24. /**
  25. * Alter a user's real name before it is saved to the database.
  26. *
  27. * @param string $realname
  28. * The user's generated real name.
  29. * @param object $account
  30. * A user account object.
  31. *
  32. * @see realname_update()
  33. *
  34. * @ingroup realname
  35. */
  36. function hook_realname_alter(&$realname, $account) {
  37. }
  38. /**
  39. * Respond to updates to an account's real name.
  40. *
  41. * @see realname_update()
  42. *
  43. * @ingroup realname
  44. */
  45. function hook_realname_update($realname, $account) {
  46. }
  47. /**
  48. * @} End of "addtogroup hooks".
  49. */