Action and Filter Hooks

List of available action and filter hooks supported by UserMetaPro.

Forms and Fields

1. Action Hook: user_meta_before_form
   Runs when generating form. Calling just before <form> tag.
   Parameter: (string) $formName

2. Action Hook: user_meta_after_form
   Runs when generating form. Calling just after <form> tag.
   Parameter: (string) $formName

3. Filter Hook: user_meta_form_config
   Can be modify forms data by calling this filter hook.
   Parameter: (array) $formData, (string) $formName

4. Filter Hook: user_meta_field_config
   Can be modify fields data by calling this filter hook.
   Parameter: (array) $formData, (int) $fieldID, (string) $formName

5. Filter Hook: user_meta_field_display
   Applied to field html before browser output.
   Parameter: (string) $html, (int) $fieldID, (string) $formName, (array) $formData

6. Filter Hook: user_meta_form_display
   Applied to form html before browser output.
   Parameter: (string) $html, (string) $formName, (array) $formData

User Registration

1. Fliter Hook: user_meta_pre_user_register
   This filter can be used to modify user data before user registration.
   Parameter: (array) $userData

2. Action Hook: user_meta_after_user_register
   This action will run immediately after user registration.
   Parameter: (object) $response

User Profile Update

1. Fliter Hook: user_meta_pre_user_update
   This filter can be used to modify user data before user profile update.
   Parameter: (array) $userData

2. Action Hook: user_meta_after_user_update
   Runs when user update their profile.
   Parameter: (object) $response

User Activation/Deactivation

1. Action Hook: user_meta_user_activate
   Runs when user activated.
   Parameter: (int) $userID

2. Action Hook: user_meta_user_deactivate
   Runs when user deactivated.
   Parameter: (int) $userID

Email Verification

1. Action Hook: user_meta_email_verified
   Runs when user verified their email.
   Parameter: (int) $userID

Redirection

1. Filter Hook: login_redirect
   Can be used to change login redirection url.
   Parameter: (string) $url, (string) $request_url, (WP_User | WP_Error) $user

2. Filter Hook: logout_redirect
   Can be used to change login redirection url.
   Parameter: (string) $url, (string) $request_url, (WP_User) $user

3. Filter Hook: registration_redirect
   Can be used to change login redirection url.
   Parameter: (string) $url, (int) $userID

Note: By default, all redirection filters is disabled. To enable them use user_meta_wp_hook filter.

User Export

1. Filter Hook: user_meta_user_export_filename (since 1.2)
   Change file name of exported csv file.
   Parameter: (string) $fileName

2. Filter Hook: user_meta_user_export_csv_delimiter (since 1.2)
   Change default delimiter ,
   Parameter: (string) $delimiter

3. Filter Hook: user_meta_user_export_csv_enclosure (since 1.2)
   Change default enclosure "
   Parameter: (string) $enclosure

4. Filter Hook: user_meta_user_export_label (since 1.2)
   Change label of csv file (first row).
   Parameter: (array) fields

5. Filter Hook: user_meta_user_export_fields (since 1.2)
   Change field value of exported file.
   Parameter: (array) $userData, (WP_User) $user

Misc

1. Filter Hook: user_meta_msg
   Message text can be changed by this filter.
   Parameter: (string) $message, (string) $key

2. Filter Hook: user_meta_wp_hook (since 1.1.6)
   Enable or disable conflicted hooks.
   Parameter: (boolean) $enable, (string) $hookName, (array) $args