User API example including user cancel

I saw that you were working on user_delete, and old friend (and enemy) of mine. I have to hook_form_alter() that puppy to make it simple enough for my users to delete themselves :-)

Passes now.

Sorry to delay this suggestion until now, but it seems to me that user_cancel is too narrow.

Could we expand this into a user_example, or user_api_example? Demonstrate the various user apis?

If you feel like things will do better in separate modules then you can

1. Put them in submodules
or
2. Put them just in separate .inc files that make it clear where the different functionality is.

Either way makes sense for me. As always, the key is "what will people be able to understand".

Hi ilo,

Have you done any work on point 3. above?? Very curious if you have! D6 or D7.

If you looking for some help or implementation ideas give me a shout too...

Thanks,
Justin

I'm working on a D6 basic user API example module that will demonstrate the basics of hook_user(). For now, it's just user_example.module, but we can easily refactor it as more examples are added later.

For some reason there isn't a version on this issue so I'm setting it to 6.x for now.

Here's an example of a basic form element for the user edit page, including saving it to a custom table and validating the value submitted.

#17: 933624.17-user_api_example_6.x.patch queued for re-testing.

I'm good with #18 - It just needs a menu entry with a page to explain how it works. And it needs to be added to the main index. I'd like to see tests, but could live without in D6.

Here's a patch with a page callback added. I'm not sure what index you're referring to - just the one on the d.o module page?

I think adding tests might complicate the example further. If we really want them, I'd need to refactor the example a bit to be API centric (instead of just helper functions for hook_user()).

We'd want tests for QA purposes, not so much educational ones. Good tests can illustrate techniques as well, though. But like rfay says: It's for D6, which will soon see end-of-life.

The main index page went away, and we rely on api.drupal.org to show nice lists: http://api.drupal.org/api/examples/6

#20: 933624.20-user_api_example_6.x.patch queued for re-testing.

So a few problems with the patch in #20, but since 6 months has passed I just went ahead and fixed them.

1) Code like this, in user_example_user():

+function user_example_user($op, &$edit, &$account, $category = NULL) {
[..]
+        return _user_example_add_color_element(&$edit, &$account);

This is a reference to a reference, which PHP 5.2.17 finds acceptable but PHP 5.4.4 does not. Take out the ampersands and both are happy. I suppose the test bot uses an old version of PHP.

2) Some Doxy problems, such as not defining a @group.

3) Added some context as to how you'd do this in D7. (Just use a field.)

Ideally, the docblocks would have a better explanation of hook_user()'s workings, in addition to explaining $edit. We also might incorporate the user cancel stuff. But I'm eager to get D6 issues put to bed, so we're committed:

http://drupalcode.org/project/examples.git/commitdiff/9ac8c63f02c70c2f70...

Thanks, deviantintegral. :-)