Make WordPress Core

Opened 9 years ago

Closed 9 years ago

#34522 closed defect (bug) (fixed)

Incorrect docblock for embed_defaults filter

Reported by: swissspidy's profile swissspidy Owned by: drewapicture's profile DrewAPicture
Milestone: 4.4 Priority: normal
Severity: trivial Version: 2.9
Component: Embeds Keywords: good-first-bug has-patch
Focuses: docs Cc:

Description (last modified by swissspidy)

The embed_defaults filter passes width and height in an array (using compact), and the url as a second param. The docblock lists three params though.

It should be made clear that only two paerams are passed to the filter callback.

Attachments (1)

34522.diff (722 bytes) - added by swissspidy 9 years ago.

Download all attachments as: .zip

Change History (4)

#1 @swissspidy
9 years ago

  • Description modified (diff)

9 years ago

#2 @swissspidy
9 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Awaiting Review to 4.4
  • Owner set to DrewAPicture
  • Severity changed from normal to trivial
  • Status changed from new to assigned
  • Version set to 2.9

#3 @DrewAPicture
9 years ago

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

In 35485:

Docs: Correctly notate that the default $width and $height embed dimensions are passed to the embed_defaults filter as a compacted array, and not two distinct parameters.

Props swissspidy.
Fixes #34522.

Note: See TracTickets for help on using tickets.