Top Posts: allow one to customize avatar image options w/ filter

[jeherve]

Changes proposed in this Pull Request:

The jetpack_top_posts_widget_image_options filter allows third-parties to specify custom image options, including the fallback_to_avatars parameter. However we currently do not use the value that comes from the filter when we actually fetch the image. That fixes it.

Testing instructions:

• Create a new post without any image, and make sure it appears as one of the most visited posts in the Top Posts widget you add to your sidebar.
• By default, the post should show the author's Gravatar.
• Now add the following code snippet to your site:

function jeherve_custom_top_posts_images( $get_image_options ) {
        $get_image_options['fallback_to_avatars'] = false;
  
        return $get_image_options;
}
add_filter( 'jetpack_top_posts_widget_image_options', 'jeherve_custom_top_posts_images' );

• The Gravatar should disappear.

Proposed changelog entry for your changes:

• Top Posts: allow one to customize avatar image options with a filter.

[matticbot]

Caution: This PR has changes that must be merged to WordPress.com
Hello jeherve! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer, review, and approve D30721-code before merging this PR. Thank you!

[jetpackbot]

Thank you for the great PR description!

When this PR is ready for review, please apply the [Status] Needs Review label. If you are an a11n, please have someone from your team review the code if possible. The Jetpack team will also review this PR and merge it to be included in the next Jetpack release.

Scheduled Jetpack release: August 6, 2019.
Scheduled code freeze: July 30, 2019

Generated by 🚫 dangerJS against 72d66bb

[brbrr]

For some reason, I can not make gravatar image to disappear when using Image List or Image Grid display options. Text List option does not display images by default. Maybe am I doing something wrong?

I tried adding jeherve_custom_top_posts_images filter via Snippets plugin and into mu-plugin directly.

[brbrr]

I made it work with JN site. unfortunately, it seems it does not work as advertised:

• I can see a bunch of PHP Warning: Illegal string offset 'src' in /srv/users/userf429d970/apps/userf429d970/public/wp-content/plugins/jetpack-dev/modules/widgets/top-posts.php on line 372
• widget code tries to render an image since it follows the grid / image formatting, but since image is null - it renders broken image icon.

I think we should render a text-only formatting in this case

[jeherve]

@brbrr Yes, that is one of the reasons we have that fallback in the first place.

If someone gets rid of that fallback, I think it's reasonable to expect that they would have another fallback in place instead, such as a function hooked into jetpack_images_get_images as explained here:
https://developer.jetpack.com/hooks/jetpack_images_get_images/

I think we can add a better handling of errors when no image can be found, but I think that belongs in a different PR.

[brbrr]

Make sense. LGTM!