The documentation for hook_modules_uninstalled lists the $modules parameter as a string ("The name of the uninstalled module."). This is incorrect, the $modules parameter is an array.

CommentFileSizeAuthor
#3 system.api_.modules-parameter-712364-3.patch429 bytesdjac

Comments

jhodgdon’s picture

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

Good point!

djac’s picture

djac commented
Assigned: Unassigned » djac
Status: Needs review » Active
djac’s picture

djac commented
Assigned: djac » Unassigned
Status: Active » Needs review
StatusFileSize
new system.api_.modules-parameter-712364-3.patch429 bytes

Updated hook_modules_uninstalled() documentation to specify that $modules is an array.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Looks quite reasonable to me. Thanks!

The only thing I would say for next time is that if a parameter is an array, we are encouraging 

* @param array $modules

i.e. putting the data type before the parameter name. But as this is not exactly a doc *requirement* now...

djac’s picture

djac commented
Issue tags: +D7csmtl

I tried to use similar syntax/wording as hook_modules_installed(), but I will keep your suggestion in mind for next time, as I agree with you 100%!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

It's a new standard, and not many functions are using it.

dries’s picture

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

Good catch. Committed to CVS HEAD.

Status: Fixed » Closed (fixed)
Issue tags: -Quick fix, -Novice, -D7csmtl

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

Issue tags: +Quick fix, +Novice, +D7csmtl

Restoring issue tags, see #2125755: System messages removed all issue tags during D7 upgrade.