Add additional filters to the image presenter.

[thijsoo]

Context

• We want to allow users to filter all og:image properties.

Summary

This PR can be summarized in the following changelog entry:

• Adds additional filter options for the og:image meta tags.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

• Add an OG image to a post.
• Make sure you have: meta property="og:image" <meta property="og:image:width" <meta property="og:image:height"<meta property="og:image:type" in your source code.
• Add the following filter and make sure the values change:

add_filter( 'wpseo_opengraph_image', 'change_opengraph_image_url' );
add_filter( 'wpseo_opengraph_image_width', 'change_opengraph_image_width' );
add_filter( 'wpseo_opengraph_image_height', 'change_opengraph_image_height' );
add_filter( 'wpseo_opengraph_image_type', 'change_opengraph_image_type' );

function change_opengraph_image_url( $url ) {
	return 'https://example.com/uploads/2019/03/image.png';
}

function change_opengraph_image_width( $width ) {
	return 10408;
}

function change_opengraph_image_height ( $height ) {
	return 4800;
}
function change_opengraph_image_type ( $type ) {
	return 'type';
}

• Smoke test nothing changes when there is no OG image.
• Smoke test that the first content image is still used as OG image and that the values are not overwritten when the filters are disabled but are when they are enabled.
• Smoke test there are no differences in meta when switching between trunk and this pr with no filters enabled.

Relevant test scenarios

• Changes should be tested with the browser console open
• Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
• Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
• Changes should be tested on different browsers
• Changes should be tested on multisite

Test instructions for QA when the code is in the RC

• QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

• This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

• This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

• I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

• I have tested this code to the best of my abilities.
• During testing, I had activated all plugins that Yoast SEO provides integrations for.
• I have added unit tests to verify the code works as intended.
• If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
• I have written this PR in accordance with my team's definition of done.
• I have checked that the base branch is correctly set.

Innovation

• No innovation project is applicable for this PR.
• This PR falls under an innovation project. I have attached the innovation label.
• I have added my hours to the WBSO document.

Fixes #

[leonidasmi]

CR: 🏗️

I would also like to see some test instructions/impact check for other cases of og image sources other than the feature image (eg. the first content image).

[coveralls]

Pull Request Test Coverage Report for Build 798e92d558de9153cab8be13d5bc21ac1fa7211a

Details

• 14 of 14 (100.0%) changed or added relevant lines in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.009%) to 52.645%

---

Totals
Change from base Build 5c69bf7f9e9b2722313b5f23207ead0be6f1bba7:	0.009%
Covered Lines:	28312
Relevant Lines:	54396

---

💛 - Coveralls

[leonidasmi]

CR + AT is ✅

[Dominic-Marcelino]

Thank's for the update! Is there already a timeline when these will be included in a new yoast version?

[thijsoo]

Hi @Dominic-Marcelino We don't know yet when this will be released. I will try to communicate this when we do!