Found a couple of issues with the image.module hooks_ documentation.

1. Documentation for hook_image_style_flush() makes reference to a non-existent UI for flushing a style.

2. Documentation for hook_image_style_alter() argument should be passed by reference.

3. Example function for hook_image_style_alter() is missing code. The example needs to include an 'effect callback' key in the array. It is required, and without it Drupal throws errors. The php docs for the function should probably clarify this as well.

Files: 
CommentFileSizeAuthor
#1 658056-theunraveler.patch1.45 KBtheunraveler
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 658056-theunraveler.patch. View

Comments

theunraveler’s picture

Status: Active » Needs review
FileSize
1.45 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 658056-theunraveler.patch. View

Here's a patch.

Regarding issue #1, I took the reference to the nonexistent UI out of the documentation, but while we were working on this issue, we came up with some good arguments to reintroduce the UI for flushing Image presets. See #700696: Add 'flush' back into image module for more info.

eojthebrave’s picture

Status: Needs review » Reviewed & tested by the community

I like it. Thanks!

webchick’s picture

Status: Reviewed & tested by the community » Fixed

Nice clean-up, thanks! Committed to HEAD.

Status: Fixed » Closed (fixed)

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