Conditionally display featured image on singular posts and pages

Description

Important notice

If your theme does a customized call to load the featured image (like the Twenty Seventeen theme), this plugin might not work! Use get_the_post_thumbnail() or wp_get_attachment_image() to be sure it will work.

Description

This plugin lets you choose for each post or page, if the featured image should be shown in the single view. This can get handy, if you use the featured image to show a thumbnail on the archives or front page but you don’t want the featured image to be shown on every posts view itself.

The plugin adds a simple checkbox to the featured image panel (or meta box if you are using the classic editor), that lets you choose, if the featured image will be shown in the singular view or not.

Screenshots

  • Backend
  • Frontend

Installation

  1. Upload the plugin files to the /wp-content/plugins/conditional-featured-image directory, or install the plugin through the WordPress plugins screen directly.
  2. Activate the plugin through the Plugins screen in WordPress

FAQ

The plugin doesn’t work with my theme. What can I do?

Typically there are two possibilities why the plugin is not compatible with your theme:

1) The theme loads the featured image before the loop (e.g. in the header).
2) The theme makes a custom call to load the featured image.

In case 1 you can initialize the plugin early. To do so, add the following snippet to your functions.php:

function cybocfi_set_startup_hook() {
    return 'get_header';
}

add_filter( 'cybocfi_startup_hook', 'cybocfi_set_startup_hook' );

Be aware, that this might have some side effects: e.g. it might also hide the featured image from plugins that would normally see it, like SEO plugins et al.

In case 2 either

  • kindly ask the theme developer to use one of the dedicated WordPress functions (wp_get_attachment_image(), get_the_post_thumbnail(), the_post_thumbnail()) to load the featured image in the singular views.
  • or create a child theme that replaces the call, that loads the featured image, with one of the methods listed above.

Can I hide featured images by default?

Yes. Just add the following line to your functions.php:

add_filter('cybocfi_hide_by_default', '__return_true');

All new posts and pages will now hide the featured image by default (checkbox is checked by default). Existing posts and pages won’t be changed.

You may also set different default values depending on the post type:

function cybocfi_set_default_hiding_state( $default, $post_type ) {
    if ( 'post' === $post_type ) {
        $default = true; // set the default state for posts
    } else if ( 'page' === $post_type ) {
        $default = false; // set the default state for pages
    }

    return $default;
}
add_filter( 'cybocfi_hide_by_default', 'cybocfi_set_default_hiding_state', 10, 2 );

Can I limit this plugin to posts (and exclude other post types)?

Yes. By default, the plugin is available on any post type, that has a featured image. But there is a filter, that lets you control, for with post types the plugin should be available. The following example limits it to posts only:

function cybocfi_enable_by_post_type( $post_type ) {
    return 'post' === $post_type;
}
add_filter( 'cybocfi_post_type', 'cybocfi_enable_by_post_type' );

The filter provides you the current post type and you can decide if you want to use the plugin for this post type by returning true to enable and false to disable it. Add the following snippet to your functions.php to enable the plugin for posts and pages, but disable it for any other post type:

function cybocfi_enable_by_post_type( $post_type ) {
    $allowed_post_types = array( 'post', 'page' ); // add any post type you want to use the plugin with
    return in_array( $post_type, $allowed_post_types );
}
add_filter( 'cybocfi_post_type', 'cybocfi_enable_by_post_type' );

Is it possible to get the plugin in my language?

Absolutely. You’re invited to contribute a translation in your language. Please keep in mind, that the translation needs to be reviewed by the community, so it will take a little while until it gets accepted.

How can I change the text of the checkbox?

There is a filter hook for this. Add the following snippet to your functions.php:

function cybocfi_set_featured_image_label( $label ) {
    return 'Hide featured image in post'; // change this string
}
add_filter( 'cibocfi_checkbox_label', 'cybocfi_set_featured_image_label' );

I can’t save posts in WordPress 5.7.0

A bug in WordPress core #52787 may render this plugin unusable if a second plugin uses post meta values in a certain way. People who are affected by this problem see the following error message “Updating failed. Could not delete meta value from database.”. As the issue is related to WordPress core the workaround is to downgrade to WordPress 5.6.2 or to upgrade to WordPress 5.7.1. To our current knowledge, only very few users are affected by this defect. The Conditionally display featured image on singular posts and pages plugin itself works as expected for WordPress 5.7.0 and the issue may only appear if a second plugin triggers the bug in WordPress core.

Reviews

يناير 19, 2021
I was getting frustrated trying out all sorts of codes and plug-ins. This is the only one that worked with my theme
دجنبر 31, 2020
This has been a very handy plugin on 5 of our sites for several years. Conditionally display featured image on singular pages and posts does what it says well.
دجنبر 28, 2020
One of the best plugings that should be in your plugin list. Amazed to see the speed of the development to fix issues with the plugin. Thank you!
دجنبر 18, 2020
Just what I was looking for. This is a time saver and works great.
Read all 21 reviews

Contributors & Developers

“Conditionally display featured image on singular posts and pages” is open source software. The following people have contributed to this plugin.

Contributors

“Conditionally display featured image on singular posts and pages” has been translated into 2 locales. Thank you to the translators for their contributions.

Translate “Conditionally display featured image on singular posts and pages” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

2.8.0

  • Added hook for early initialization
  • Extended FAQ
  • Small refactorings
  • Updated dependencies

2.7.1

  • Tested up to WordPress 5.7
  • Updated dependencies

2.7.0

  • Added support for the Custom Post Type UI plugin
  • Updated dependencies

2.6.0

  • Added support for the twentynineteen theme

2.5.1

  • Fix: Do not remove the featured image in queries executed after the main query
  • Updated dependencies

2.5.0

  • Respect the cybocfi_hide_by_default filter for programmatically added posts
  • Small refactorings
  • Tested up to WordPress 5.6.0
  • Updated dependencies

2.4.0

  • Added filter to hide featured images by default
  • Tested up to WordPress 5.5.1
  • Extended FAQ
  • Updated dependencies

2.3.1

  • Tested up to WordPress 5.5 (RC1)
  • Extended FAQ
  • Updated dependencies

2.3.0

  • Allow to enable/disable the plugin by post type

2.2.0

  • Allow filtering the featured image checkbox label
  • Update readme
  • Update dependencies

2.1.2

  • Exclude none essential data from SVN

2.1.1

  • Update dependencies

2.1.0

  • Add support for Yoast SEO (don’t filter image for the social header data)

2.0.0

  • Add support for the block editor (Gutenberg)
  • Tested up to WordPress 5.2.2

1.4.0

  • Makes sure, we do only modify the main post
  • Tested up to WordPress 5.0.0

1.3.0

  • Make it more robust so it will also work with Elementor
  • Tested up to WordPress 4.9.6

1.2.2

  • Tested up to WordPress 4.7.3
  • Tested up to WordPress 4.8.0
  • Tested up to WordPress 4.9.0

1.2.1

  • Tested up to WordPress 4.7.2

1.2.0

  • Get ready for language packs (set text domain equal to the name of the plugins folder, remove load_plugin_textdomain)

1.1.3

  • Tested up to WordPress 4.7.0
  • Removed language folder. Languages are now loaded from wordpress.org

1.1.2

  • Improve plugin title
  • Improve checkbox string
  • Improve documentation
  • Updated stable tag

1.1.1

  • Updated stable tag

1.1

  • Extended functionality to pages

1.0

  • Initial public release