[RFC] user_add hook

[nickvergessen]

Name: hook_user_add
Rationale: It might be useful for some MODs to be able to do things when a new user is added.
Placement: includes/functions_user.php inside user_add:
we actually need two inside this function, one before

Code: Select all

   $sql = 'INSERT INTO ' . USERS_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary);
   $db->sql_query($sql);

so we can modify the data, before the user is added to the database, and one after we know the user_id, although one after the user_id would be fine aswell, because we can just make an UPDATE-sql then.
Input arguments: $sql_ary, $cp_data
Output format: $sql_ary, $cp_data per reference before the INSERT, afterwards it should be $cp_data per reference.

[igorw]

We could call the first one user_add and the second one user_add_after (seems like a more sustainable naming convention than user_added).

[Kellanved]

we could also - shocking - use the same hook twice. With an argument from where in the function it was called.

[igorw]

True, but I'd prefer to see individual hooks in such cases. It keeps the hook API consistent and prevents modders from having to do really awkward if/switch statements in the listeners. Well, that's just a minor detail anyway.

[Sam]

I prefer individual hooks, it's much simpler on the MOD author's end.

[Jhong]

A small point, but you might want to consider "user_add" and "user_add_before" instead. I think "before" makes it clear that no changes have been written to the database yet.

[gn#36]

It should be possible to deny adding the user through the "before" hook. A mod might set conditions that must be met, before a user can be added, for example it might check some data entered in custom profile fields (beyond just checking for the correct format, i.e. it might compare a field for membership ID with a table of all members to permit only members that are already in the database to be registered).