Opened 3 years ago
Last modified 4 months ago
#14110 new enhancement
Expose height and width attributes to 'wp_get_attachment_image_attributes' filter
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | Future Release |
| Component: | Media | Version: | 3.0 |
| Severity: | minor | Keywords: | has-patch 2nd-opinion |
| Cc: | divinenephron, scottconnerly, anatol@… |
Description
The filter 'wp_get_attachment_image_attributes' allows you to alter the attributes of embedded images. However the height and width attributes aren't passed to this filter. These would be useful to have – I'm making a theme with a fluid layout where I have to remove all height and width attributes to ensure that the browser maintains the attribute of images when they're resized.
I've attached a patch with a fix. In it I've also changed the function 'get_image_tag' so that I could remove the immensely pointless 'hwstring' function.
Attachments (4)
Change History (17)
divinenephron — 3 years ago
comment:1
divinenephron — 3 years ago
- Keywords has-patch added
- Keywords has-patch filter wp_get_attachment_image_attributes attribute height width attachment removed
I see no reason to move around so much code for such a simple request.
comment:3
divinenephron — 3 years ago
- Cc divinenephron added
- Component changed from Plugins to Media
- Keywords has-patch filter wp_get_attachment_image_attributes attribute height width attachment added
- Severity changed from normal to minor
Evidently it's rude to refactor code in an enhancement request – sorry about that.
I've attached "wp_get_attachment_image_shortened.diff" – a file that contains only the changes that are essential to the enhancement. Is that more acceptable.
- Keywords filter wp_get_attachment_image_attributes attribute height width attachment removed
- Milestone changed from Awaiting Review to 3.1
Sorry, wasn't trying to be rude. It's just really hard to see what's going on when there's a ton of unrelated red and green.
This code looks fine, aside from the coding whitespace. (We use tabs, not spaces.)
- Keywords 2nd-opinion added
- Milestone changed from 3.1 to Future Release
I think this has the potential to break the filter, for those who receive an array through wp_get_attachment_image_attributes and build their own, not expecting additional keys.
comment:6
scottconnerly — 20 months ago
- Cc scottconnerly added
I too would like to be able to access the image's height/width information from within the wp_get_attachment_image_attributes filter.
+1. When I added the wp_get_attachment_image_attributes hook (#8732), I omitted the height and width attributes because wp_get_attachment_image() had used image_hwstring() to format those. But it really doesn't make any sense that they're left out.
Replying to nacin:
I think this has the potential to break the filter, for those who receive an array through wp_get_attachment_image_attributes and build their own, not expecting additional keys.
That's true. I wonder how common that is.
Let plugins filter image dimensions via wp_get_attachment_image_attributes filter (*props divinenephron*). Restore image dimensions if they're missing after applying the filter (consistent with the wp_get_attachment_image()'s previous behavior). Pass $icon to the filter too. Move esc_attr closer to output. Update documentation. Whitespace.
Replying to nacin:
I think this has the potential to break the filter, for those who receive an array through wp_get_attachment_image_attributes and build their own, not expecting additional keys.
Attached wp_get_attachment_image.2.diff should cover that.
Patch may look bigger than it is. ;)
comment:10
wpsmith — 14 months ago
Wouldn't it make more sense to "restore" height/width ($attr['width']/$attr['height']) attributes as empty strings rather than their full value?
comment:11
Sam_a — 14 months ago
Hi wpsmith,
Under WordPress's current behavior, the width and height attributes don't go through the wp_get_attachment_image_attributes filter, so a plugin that builds its own $attr array and returns it without width and height doesn't actually intend to remove them (as nacin noted in #5).
So if we also expose width and height in the filter, we want to continue that behavior — if the width and height keys are missing after applying the filter, restore them to their original values, as if they hadn't been removed.
Plugins that really want to empty width and height can set them to '' or false through the filter to get that.
comment:12
anatolbroder — 4 months ago
- Cc anatol@… added
comment:13
anatolbroder — 4 months ago
Maybe you should combine the functions get_attachment_image and get_image_tag. They try to do similar things, but are both not flexible enough for using in plugins.
We need one low level function lowlevel_image for just creating an image tag from an attribute array.
<img
alt='Image'
class='image'
data-image='{JSON}'
height='456'
id='123'
src='image.png'
title='Image'
width='789'
…
/>
And we need a high level function highlevel_image for own attachment images. The highlevel_image should collect the attributes from image meta an pass them to the lowlevel_image.

Patch to give the 'wp_get_attachment_image_attributes' filter access to the heigh and width attribues.