I have recently been reading up on install profiles and while looking through some examples I came across implementations of hook_profile_tasks(). However I could not find any documentation of this hook on http://api.drupal.org.

There are two related entries that seem to document implementations of the hook in the default and example install profiles:
http://api.drupal.org/api/function/example_profile_tasks/6
http://api.drupal.org/api/function/default_profile_tasks/6

But no actual reference about the fact that you can (must?) implement this in your own profile.

After more thought, I am hesitant as to whether is function is even really a hook but more a required function. However, it seems it should have generic documentation regardless.

I am still new to install profiles so I apologize if i have misinterpreted the usage of the function.

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Hmmm...

It looks like install_task_list() implicitly calls hook_profile_task_list(), and you are correct, this is not documented. In Drupal 7, it doesn't exist, so this is a Drupal 6 issue only.

Same for install_tasks() invoking hook_profile_tasks().

Thanks for reporting this issue!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

As a note, I've filed a separate issue to ask that the Examples for Developers project adopt this sample profile, since it's out of date and neglected.
#715176: Adopt example.profile

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Project: Drupal core » Documentation
Version: 6.x-dev »
Component: documentation » API documentation files

This file is actually in the Documentation project now. See also #1166626: Example profile is totally wrong for Drupal 7

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue tags: +valid issue

Tagging so #1421874: [meta] Documentation Issue Queue Cleanup doesn't have to look at API docs issues.

arianek’s picture

arianek commented

Should this actually be in the API queue?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

No. The files for this are in the Documentation project issue queue, which is what "API documentation files" component is for.

arianek’s picture

arianek commented

Ah nevermind then! You'll have to brief me on how to know the difference of which queue is which so I don't accidentally send them over there. ;) Maybe tomorrow...

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

The only things left in the Documentation git repository are:
- Drupal 6 - hook_* documentation (moved to Drupal Core in 7/8)
- All versions - Form API reference page

arianek’s picture

arianek commented

Ah, I see - didn't realize it was a couple specific pieces. That makes sense, thanks!

sven.lauer’s picture

sven.lauer commented

Although this is off topic here, a quick addendum to #8: The documentation for global variables is also in the doc repository, for all versions.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
Status: Active » Closed (outdated)

Updating old issues. This is 6.x only. We're not really fixing 6.x issues any more. Sorry.