You are here

Home » API reference » User Import 7.3

API.txt in User Import 7.3

Same filename and directory in other branches
  1. 8 API.txt
  2. 6.4 API.txt
  3. 6.2 API.txt
  4. 7 API.txt
  5. 7.2 API.txt

Overview
========

Import users into Drupal from a csv file (comma separated file).

See files in user_import/supported/ for examples of the API in use.

hook_user_import_form_field_match()
===========================================
Add options to list of Drupal fields to match against column of data being imported.


hook_user_import_form_update_user()
===========================================
Add options to the import settings form.


hook_user_import_data()
===========================================
Manipulate imported data before creating or amending user accounts.


hook_user_import_after_save()
===========================================
Take action(s) after each user account is created or amended.


hook_user_import_imported()
===========================================
Take action(s) after import is complete.

hook_field_user_import_supported_alter(&$supported)
===========================================
Alter array of supported field types, allowing for adding custom field
processors. Example:

MODULE_field_user_import_supported_alter(&$supported) {
 $supported['MODULE'] = array(
   'validate' => 'MODULE_user_import_field_validator',
   'save' => 'MODULE_user_import_field_processor',
 );
}

File

API.txt
View source 
  1. 

  2. 

  3. Overview

  4. ========

  5. 

  6. Import users into Drupal from a csv file (comma separated file).

  7. 

  8. See files in user_import/supported/ for examples of the API in use.

  9. 

  10. hook_user_import_form_field_match()

  11. ===========================================

  12. Add options to list of Drupal fields to match against column of data being imported.

  13. 

  14. 

  15. hook_user_import_form_update_user()

  16. ===========================================

  17. Add options to the import settings form.

  18. 

  19. 

  20. hook_user_import_data()

  21. ===========================================

  22. Manipulate imported data before creating or amending user accounts.

  23. 

  24. 

  25. hook_user_import_after_save()

  26. ===========================================

  27. Take action(s) after each user account is created or amended.

  28. 

  29. 

  30. hook_user_import_imported()

  31. ===========================================

  32. Take action(s) after import is complete.

  33. 

  34. hook_field_user_import_supported_alter(&$supported)

  35. ===========================================

  36. Alter array of supported field types, allowing for adding custom field

  37. processors. Example:

  38. 

  39. MODULE_field_user_import_supported_alter(&$supported) {

  40.  $supported['MODULE'] = array(

  41.    'validate' => 'MODULE_user_import_field_validator',

  42.    'save' => 'MODULE_user_import_field_processor',

  43.  );

  44. }