Conditionally display featured image on singular posts and pages

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 and disable the in_the_loop check. 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' );
add_filter( 'cybocfi_only_hide_in_the_loop', '__return_false' );

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 or the ‘latest posts’ plugin.

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.

Is this plugin GDPR compliant?

This plugin does not process or store any personal information. Hence, it is fully GDPR compliant without any further ado.

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 which post types the plugin should be available. The following example disables it for anything except for posts:

function cybocfi_limit_to_posts( $enabled, $post_type ) {
    if ( 'post' === $post_type ) {
        return $enabled;
    }

    return false;
}
add_filter( 'cybocfi_enabled_for_post_type', 'cybocfi_limit_to_posts', 10, 2 );

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_limit_to_posts_and_pages( $enabled, $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_enabled_for_post_type', 'cybocfi_limit_to_posts_and_pages', 10, 2 );

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.

I’m getting a deprecation notice, what must I do?

The cybocfi_post_type filter was deprecated in favor of cybocfi_enabled_for_post_type, as the filter arguments were used in an unusual way. Transitioning from the former to the latter is easy. Here an example:

// Using the deprecated filter - REMOVE THIS CALL
function cybocfi_limit_to_posts( $post_type, $enabled ) {
    if ( 'post' === $post_type ) {
        return $enabled;
    }

    return false;
}
add_filter( 'cybocfi_post_type', 'cybocfi_limit_to_posts', 10, 2 );

// Using the new filter - THIS IS HOW IT SHOULD BE DONE NOW
function cybocfi_limit_to_posts( $enabled, $post_type ) {
    if ( 'post' === $post_type ) {
        return $enabled;
    }

    return false;
}
add_filter( 'cybocfi_enabled_for_post_type', 'cybocfi_limit_to_posts', 10, 2 );

All you’ve got to do is:

1) Change the filter hook from cybocfi_post_type to cybocfi_enabled_for_post_type.
2) Swap the filter functions arguments. $enabled is now the first argument $post_type the second.

In case you’ve only used one argument ($post_type), you must not only adapt the function signature, but also add the priority and number of arguments to your add_filter() function call. Just as it is shown in the example above.