Allow post types to override the phrase "Featured image"

[johnbillion]

It would be nice if the phrase "Featured image" could be filtered so it could be tailored to fit its post type. For example:

• A post type of 'person' could set it to 'Mugshot'
• A post type of 'album' could set it to 'Cover art'
• A post type of 'company' could set it to 'Company Logo'

Patch upcoming.

[nacin]

Filtering the text itself is rather easy (if hacky), but it would be especially nice if set_post_thumbnail_size() and add_image_size() could be drilled down to individual post types.

See #18057 (patch on #18027) for something similar - the ability to define a "usage" for a featured image.

[johnbillion]

Here's my take on this. The attached patch adds three new labels to the post type objects. The defaults are:

• featured_image => 'Featured Image'
• set_featured_image => 'Set featured image'
• remove_featured_image => 'Remove featured image'
• use_featured_image => 'Use as featured image'

These strings are used in the featured image meta box and in the media lightbox.

A custom post type would set its own labels for featured images like so:

register_post_type( 'company', array(
	'labels' => array(
		'featured_image' => 'Company Logo',
		'set_featured_image' => 'Set company logo',
		'remove_featured_image' => 'Remove company logo',
		'use_featured_image' => 'Use as company logo'
	)
) );

[DrewAPicture]

Replying to johnbillion:

A custom post type would set its own labels for featured images like so:

register_post_type( 'company', array(
	'labels' => array(
		'featured_image' => 'Company Logo',
		'set_featured_image' => 'Set company logo',
		'remove_featured_image' => 'Remove company logo',
		'use_featured_image' => 'Use as company logo'
	)
) );

+1 for this. This would be very helpful for many of my projects.

[jane]

Sounds good to me.

[johnbillion]

I know it's late but this would be nice to see in 3.5.

[JustinSainton]

+1 for the idea - not sure on the implementation of adding the labels vs. filters. But this would be super helpful. Currently filtering via gettext - which is hacky (like nacin said).

[nacin]

Replying to nacin:

Filtering the text itself is rather easy (if hacky), but it would be especially nice if set_post_thumbnail_size() and add_image_size() could be drilled down to individual post types.

I think this should wait for this to occur. Filtering via gettext at least works. Adding an API for post types to modify the *labels* is completely lame if they can't do post-type-specific featured images.

The media, image, and thumbnail work in 3.5 should enable this to happen in 3.6 (probably not sooner).

[chriscct7]

This a pretty cool idea and would be useful for many plugins. Patch needs a refresh

[mordauk]

19257-2.patch is a refreshed and working patch.

[mordauk]

19257-tests.patch adds a unit test for labels.

[valendesigns]

@johnbillion I started reviewing this on Wednesday, but I got sidetracked and I took yesterday off. I'll review it today in the next couple hours.

[valendesigns]

Did a review and everything looks correct. There were some extra white spaces and the patch didn't apply clean anymore, so I refreshed it. As well, There were missing param docs in get_post_type_labels that I added in the process. Should be ready to go.

[johnbillion]

In 32673:

Introduce featured_image, set_featured_image, remove_featured_image, and use_featured_image post type labels when registering a post type in order to override the 'Featured Image' text and its related phrases.

Props johnbillion, mordauk, valendesigns.
Fixes #19257.

[johnbillion]

r32673 is causing notices on the Media screen:

Trying to get property of non-object in ~/wp-includes/media.php on line 3011

Looks like $post at that point can be null.

[SergeyBiryukov]

In 32675:

Avoid a PHP notice in wp_enqueue_media() if $post is null.

see #19257.

[SergeyBiryukov]

[32673] broke make/core: get_post_types() does not exist in wp-admin/load-scripts.php (only exists if SCRIPT_DEBUG is true).

[SergeyBiryukov]

It looks like WPSetAsThumbnail() is never used in post-3.5 media UI and is only kept for back compat, so this part can be reverted.

[SergeyBiryukov]

In 32676:

Revert a part of [32673] that caused a fatal error with SCRIPT_DEBUG disabled.

see #19257.

[obenland]

@johnbillion, what is left to do here?

[johnbillion]

This wasn't as stable as I'd hoped, but Sergey's tweaks all look good, and no other breakage reports in 3 weeks. Closing.