WordPress.org

Make WordPress Core

Opened 3 years ago

Last modified 10 months ago

#20205 new enhancement

Add the ability to filter wp_get_attachment_image()

Reported by: helgatheviking Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version: 3.4
Component: Media Keywords: has-patch
Focuses: Cc:

Description

i'm working on a plugin that lets users define any image to serve as the thumbnail for any PDF document. I'm storing the ID of the image as post_meta for the PDF attachment. Instead of showing the default icon with wp_get_attachment_image() I'm quite close to being able to do this by filtering image_downsize.

the trouble is that the image_downsize filter it run after

if ( !wp_attachment_is_image($id) )
		return false;

so the PDF image fails the test and I never have a chance to run my filter.

Attachments (9)

post.php.patch (614 bytes) - added by helgatheviking 3 years ago.
add argument to icon_dir filter
media.php (50.6 KB) - added by helgatheviking 3 years ago.
add argument to icon_dir filter
media.php.patch (642 bytes) - added by jfarthing84 3 years ago.
Add a filter to wp_get_attachment_image_src() within wp_get_attachment_image().
20205.patch (347 bytes) - added by SergeyBiryukov 3 years ago.
media.php.2.patch (1.6 KB) - added by doublesharp 2 years ago.
wp_get_attachment_image_src filter in wp_get_attachment_image_src() function
20205.2.patch (349 bytes) - added by jfarthing84 2 years ago.
Refreshing 20205.patch from trunk.
20205.3.patch (1.3 KB) - added by jfarthing84 2 years ago.
Filter wp_attachment_image_src instead.
20205.diff (2.6 KB) - added by ericlewis 10 months ago.
20205.1.diff (2.7 KB) - added by ericlewis 10 months ago.

Download all attachments as: .zip

Change History (46)

comment:1 @helgatheviking3 years ago

sorry that should read PDF attachment and not PDF image

comment:2 @scribu3 years ago

  • Component changed from General to Media

Moving the filter below the wp_attachment_is_image() check might have back-compat implications.

Last edited 2 years ago by scribu (previous) (diff)

comment:3 @helgatheviking3 years ago

ok, well then what about adding a filter to the wp_attachment_is_image check?

if ( !(apply_filters ( 'wp_attachment_is_image' , wp_attachment_is_image($id), $id, $size)))
	return false;

should provide back compatibility while still allowing it to be overridden.

comment:4 @jeremyfelt3 years ago

Would the wp_mime_type_icon filter work? Seems that it could run in this scenario after image_downsize returns false.

comment:5 @helgatheviking3 years ago

i looked at the wp_mime_type_icon filter and it almost works. you can send back a custom URL to the wp_mime_type_icon filter, but the URL gets truncated down to simply the filename by wp_basename($src) in the wp_get_attachment_image_src() function.

if ( $icon && $src = wp_mime_type_icon($attachment_id) ) {  
		$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' );  
		$src_file = $icon_dir . '/' . wp_basename($src); 
		@list($width, $height) = getimagesize($src_file);
	}

i've also tried filtering the icon directory through the icon_dir filter, but b/c there are no variables passed i cannot get the directory to be the exact directory the custom icon is in.

so i can filter the $src of my icon to be:

http://localhost/multi/wp-content/uploads/2011/11/capri-100x100.jpg

and i can filter the icon directory path to be the uploads directory

D:\Users\helga\xampp\htdocs\multi/wp-content/uploads

but b/c the

$src_file = $icon_dir . '/' . wp_basename($src);


the end result for $src_file is:

D:\Users\helga\xampp\htdocs\multi/wp-content/uploads/capri-100x100.jpg

which is missing the sub-directories. i thought about trying to send an empty path to the icon_dir filter and sending the full path to the wp_mime_type_filter, but you can't do that either b/c of that string '/' in the way.

http://localhost/multi/wp-content/uploads/2011/11/capri-100x100.jpg

comment:6 @helgatheviking3 years ago

actually i think the function is choking (in terms of being able to do what i am trying to do)

on the next line in wp_get_attachment_src()

	if ( $icon && $src = wp_mime_type_icon($attachment_id) ) {
		$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' );
		$src_file = $icon_dir . '/' . wp_basename($src);
		@list($width, $height) = getimagesize($src_file);
	}
	if ( $src && $width && $height )
		return array( $src, $width, $height );
	return false;

b/c of what i mentioned above, the path info is wrong, which leads to not getting the $height and $width, which ends in the function returning false.

comment:7 @helgatheviking3 years ago

what about passing the $attachment_id to the icon_dir filter as a second parameter? that shouldn't cause any back-compat issues.

$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal', $attachment_id );

@helgatheviking3 years ago

add argument to icon_dir filter

@helgatheviking3 years ago

add argument to icon_dir filter

comment:8 @SergeyBiryukov3 years ago

Related/duplicate: #8268

comment:9 @jfarthing843 years ago

  • Cc jeff@… added

+1 for this.

There are many different ways to tackle this issue. Whether it be through wp_get_attachment_image(), wp_get_attachment_image_src() or image_downsize(). They are all called successively.

I believe a simple new filter on wp_get_attachment_image_src() within wp_get_attachment_image() should work.

@jfarthing843 years ago

Add a filter to wp_get_attachment_image_src() within wp_get_attachment_image().

comment:10 @jfarthing843 years ago

  • Keywords has-patch dev-feedback added

comment:11 @jfarthing843 years ago

  • Summary changed from move image_downsize filter to beginning of image_downsize() function to Add the ability to filter wp_get_attachment_image()

comment:12 @helgatheviking3 years ago

wow a duplicate from 4 years ago! i almost have to applaud that. i would have to dig out the code i was working on to see if this would work for what I was attempting, but it definitely looks like an elegant solution. 1 line of code and shouldn't have any backcompat issues. i hope it makes it into core.

comment:13 @helgatheviking3 years ago

any progress on adding jfarthing84's patch?

@SergeyBiryukov3 years ago

comment:14 @SergeyBiryukov3 years ago

Looking at media.php.patch, it seems weird that wp_get_attachment_image_src filter is not inside the wp_get_attachment_image_src() function.

20205.patch adds wp_get_attachment_image filter.

Given your use case, post.php.patch also makes sense to me.

comment:15 @helgatheviking3 years ago

my post.php.patch is minimally intrusive. adding one more argument shouldn't break anything.

i'd agree that a wp_get_attachment_image_src filter should be inside the wp_get_attachment_image_src function, but that function is currently structured such that if you are getting the attachment_image for a non-image, you pretty much fail right away b/c if you don't get an image back from image_downsize(), you get kicked to looking for an icon. and there's no way to return an image from an attachment's postmeta, b/c image_downsize() immediately returns false if the attachment itself isn't an image.

i like your solution too though. it should be there, but for my use case, it is a little late and would be redundant. but a filter for wp_get_attachment_image_src definitely gives the most control. just a matter of where it should be. it is definitely trickier in the wp_get_attachment_image_src function b/c there are places where a value could return

Last edited 3 years ago by helgatheviking (previous) (diff)

@doublesharp2 years ago

wp_get_attachment_image_src filter in wp_get_attachment_image_src() function

comment:16 @doublesharp2 years ago

Added a new patch for media.php (media.php.2.patch) that places the wp_get_attachment_image_src filter in the wp_get_attachment_image_src() function. Multiple returns are removed in favor of a single array which is then filtered, and if the result is still empty() returns false.

I think this makes more sense as the wp_get_attachment_image_src() could be called directly, and I would expect the results to be filtered.

comment:17 @jfarthing842 years ago

Would love to see this implemented ASAP. I am now working on a new project that includes video uploads and would like to be able to display a video thumbnail using native functions. Obviously, this can't be done until we work this out. It is a rather unfortunate situation to have to remove the default icon row from the list table completely, and replace it with my own in order to display thumbnails.

comment:18 follow-up: @markoheijnen2 years ago

If it was me I would close the ticket since that function isn't for that kind functionality. We are talking about attachments and by default they don't have any relationship with something else. I would change some of the logic a different way. Since 3.5 we have Imagick support and hopefully in 3.6 Gmagick support and with that you can create an image from a PDF.

So I guess 20205.patch makes the most sense since that would generate fallback when WordPress can't handle it.

comment:19 in reply to: ↑ 18 ; follow-up: @jfarthing842 years ago

Replying to markoheijnen:

If it was me I would close the ticket since that function isn't for that kind functionality. We are talking about attachments and by default they don't have any relationship with something else.

You don't think that serving up thumbnails of a video (attachment) should be possible with this function? I don't understand that logic.

comment:20 in reply to: ↑ 19 @markoheijnen2 years ago

Replying to jfarthing84:

Replying to markoheijnen:

If it was me I would close the ticket since that function isn't for that kind functionality. We are talking about attachments and by default they don't have any relationship with something else.

You don't think that serving up thumbnails of a video (attachment) should be possible with this function? I don't understand that logic.

WordPress can't serve a frame from a video. You need software on a server for doing that. I'm not sure if Imagick/Gmagick can do that.

comment:21 @jfarthing842 years ago

WordPress can't serve a frame from a video. You need software on a server for doing that. I'm not sure if Imagick/Gmagick can do that.

That's not the issue at hand. I should be able to serve up whatever I want in the form of an image that represents an attachment. We're just talking about a simple filter here.

Last edited 2 years ago by jfarthing84 (previous) (diff)

comment:22 follow-up: @markoheijnen2 years ago

So in my first comment I did mentioned that 20205.patch is good enough to solve this issue.

comment:23 in reply to: ↑ 22 @jfarthing842 years ago

Replying to markoheijnen:

So in my first comment I did mentioned that 20205.patch is good enough to solve this issue.

Agreed.

@jfarthing842 years ago

Refreshing 20205.patch from trunk.

comment:24 @scribu2 years ago

In summary, the use case is being able to represent non-image attachments visually, via a plugin.

Can someone provide such a sample plugin, leveraging 20205.2.patch?

Last edited 2 years ago by scribu (previous) (diff)

comment:25 @scribu2 years ago

  • Milestone changed from Awaiting Review to 3.6

comment:26 @doublesharp2 years ago

I still feel that filtering the wp_get_attachment_image_src() function is a better choice, as it is used by wp_get_attachment_image(), otherwise you will get different results if you have only filtered the latter but also need access to the image URI.

comment:27 @scribu2 years ago

I tend to agree: wp_get_attachment_image_src() is right above image_downsize(), so it would be a better fit.

comment:28 @doublesharp2 years ago

The patch that I attached - media.php.2.patch​ - does this, but is definitely a larger change than the other patches and requires additional testing and dev-feedback.

@jfarthing842 years ago

Filter wp_attachment_image_src instead.

comment:29 @markoheijnen2 years ago

The problem what I have with filtering wp_get_attachment_image_src() is the array output. I guess we should rewrite the function so you can manipulate the $src. I will give it a try now.

comment:30 @jfarthing842 years ago

The problem what I have with filtering wp_get_attachment_image_src() is the array output. I guess we should rewrite the function so you can manipulate the $src. I will give it a try now.

What's wrong with passing the whole array into the filter, as I did in the patch I just posted? If you change the image source, the dimensions are more than likely different as well and should be changed just the same.

comment:31 @markoheijnen2 years ago

The problem with that is that people will break stuff faster. I was thinking if we can make if safer and easier. They can pass the url and then call getimagesize() on it so you can retrieve the width/height.

I also not sure if we should apply the filter on the result of image_downsize().

comment:32 @jfarthing842 years ago

The problem with that is that people will break stuff faster.

Sorry, but if people "break" something, that's their own problem. There is no warranty, expressed or implied, when you utilize the available hooks that WordPress provides.

I was thinking if we can make if safer and easier. They can pass the url and then call getimagesize() on it so you can retrieve the width/height.

The problem with this approach, is that some servers do not allow calling getimagesize on a remote image. What if somebody wants to use a remote image, such as a YouTube thumb, and they already know the dimensions. They can then pass the known dimensions into the filter.

I also not sure if we should apply the filter on the result of image_downsize().

I would expect the filter to be applied to whatever result the function produces.

comment:34 @ocean9022 months ago

  • Milestone changed from 3.6 to Future Release

@ericlewis10 months ago

comment:35 @ericlewis10 months ago

  • Keywords dev-feedback removed

attachment:20205.diff cleans up this function. Let's wrap the image_downsize() call in a wp_attachment_is_image() check, this makes more logical sense, even if that check is already in that function. Don't short-circuit there, instead carry the returned value (similar to @jfarthing74's approach) through the function to be passed into the filter at the end of the function.

This also actually fixes a separate bug: you couldn't previously get the icon if the attachment is an image, it returned early with the image_downsize() call.

On a sidenote, it's convoluted that we offer an 'icon' parameter for this function. I would like to see this deprecated, and a separate function created, perhaps wp_get_attachment_icon_src().

Last edited 10 months ago by ericlewis (previous) (diff)

comment:36 @ericlewis10 months ago

#15606 was marked as a duplicate.

@ericlewis10 months ago

comment:37 @ericlewis10 months ago

In attachment:20205.1.diff, need to add backwards compatibility logic: icon will only be returned if an image was not found. If an image is found and an icon is requested, return the image.

Note: See TracTickets for help on using tickets.