These three hooks are all undocumented:

hook_field_storage_purge [see function field_purge_data() in modules/field/field.crud.inc]
hook_field_storage_purge_field [see function field_purge_field() in modules/field/field.crud.inc]
hook_field_storage_purge_instance [see function field_purge_instance() in modules/field/field.crud.inc]

Part of #675046: Make sure all hooks in D7 have documentation

CommentFileSizeAuthor
#1 777098.patch2.43 KBjhodgdon

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Needs review
StatusFileSize
new 777098.patch2.43 KB

Here's a patch

aspilicious’s picture

aspilicious commented
Status: Needs work » Needs review

DELETED COMMENTS

I was wrong, hooks have to be in the imperative form...

aspilicious’s picture

aspilicious commented
Status: Needs review » Needs work
aspilicious’s picture

aspilicious commented

After editing #2

puregin’s picture

puregin commented

I'm wondering if dropping the table in the example for hook_field_storage_purge_field() is common semantics? It seems a bit radical.
I'd probably also do without the intermediate variables. Do we need to describe @return values?

Other than that, looks good!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

That example is taken directly from code in core.

There are no return values, so we should not have a @return. Please read the standards doc, which I've given you the link to on other issues. Thanks!!

blg@bgreenaway.com’s picture

blg@bgreenaway.com commented
Status: Needs review » Reviewed & tested by the community

I concur with puregin#5, looks good!

As per standards agreement (which I hear you two have resolved now ;) no need for @return in this case - so the hook is documented perfectly and ready to commit.

Please commit.

dries’s picture

dries commented
Status: Reviewed & tested by the community » Fixed

Committed to CVS HEAD.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.