WordPress.org
Get WordPress

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#53955 closed defect (bug) (fixed)

Fix and improve the docs for the image_editor_output_format filter

Reported by: azaozz's profile azaozz Owned by: desrosj's profile desrosj
Milestone: 5.8.1 Priority: normal
Severity: normal Version: 5.8
Component: Media Keywords: has-patch commit fixed-major
Focuses: docs Cc:

Description

Follow up to [51442].

Currently the docblock for the image_editor_output_format filter contains a warning as its use may trigger several edge cases. The warning can be removed, and the docs updated after #53667 and #53668 are fixed.

Attachments (1)

53955.diff​ (1.2 KB) - added by audrasjb 3 years ago.
Remove warning from image_editor_output_format DocBlock as #53667 and #53668 are going to be fixed in 5.8.1

Download all attachments as: .zip

Change History (10)

#1 @azaozz
3 years ago

  • Milestone changed from 5.9 to 5.8.1

The related tickets are to be fixed in 5.8.1, changing the milestone here accordingly.

#2 @SergeyBiryukov
3 years ago

  • Component changed from General to Media
  • Focuses docs added

@audrasjb
3 years ago

Remove warning from image_editor_output_format DocBlock as #53667 and #53668 are going to be fixed in 5.8.1

#3 @audrasjb
3 years ago

  • Keywords has-patch added

#4 @desrosj
3 years ago

  • Keywords commit added

Marking this for commit to note it's ready, but it should only be committed and backported if both #53667 and #53668 are as well.

#5 follow-up: @azaozz
3 years ago

Wondering if that docblock can be enhanced a bit too, still needs an example of the array usage and perhaps a warning that conversion availability and quality of the converted images depends on ImageMagic or GD that is installed on the server. Can, of course, leave that for 5.9 too.

#6 in reply to: ↑ 5 @desrosj
3 years ago

Replying to azaozz:

Wondering if that docblock can be enhanced a bit too, still needs an example of the array usage and perhaps a warning that conversion availability and quality of the converted images depends on ImageMagic or GD that is installed on the server. Can, of course, leave that for 5.9 too.

Happy to include this if someone is able to update the patch! Otherwise we can make sure to add it for 5.9, and it can get backported for another 5.8.x release.

#7 @desrosj
3 years ago

  • Owner set to desrosj
  • Resolution set to fixed
  • Status changed from new to closed

In 51717:

Media: Remove documentation detailing specific edge cases in the image_editor_output_format filter.

In [51422], a few specific edge cases were detailed so that developers using the hook were aware of known pitfalls.

These edge cases have been fixed in 5.8.1 through [51653] and [51704], so the documentation is no longer necessary.

Props azaozz, audrasjb.
Fixes #53955.

#8 @desrosj
3 years ago

  • Keywords fixed-major added
  • Resolution fixed deleted
  • Status changed from closed to reopened

Reopening to backport.

#9 @desrosj
3 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 51718:

Media: Remove documentation detailing specific edge cases in the image_editor_output_format filter.

In [51422], a few specific edge cases were detailed so that developers using the hook were aware of known pitfalls.

These edge cases have been fixed in 5.8.1 through [51653] and [51704], so the documentation is no longer necessary.

Props azaozz, audrasjb.
Merges [51717] to the 5.8 branch.
Fixes #53955.

Note: See TracTickets for help on using tickets.