Deprecate suggesting VIP-equivalent cached functions: wpcom_vip_get_page_by_path(), wpcom_vip_term_exists() and wpcom_vip_get_page_by_title()

[rebeccahum]

What code should not be reported as a violation?

Since the introduction of WP 6.0+, some functions (namely wpcom_vip_get_page_by_path(), wpcom_vip_term_exists() and wpcom_vip_get_page_by_title()) we previously suggested using the VIP-equivalent are now cached:
https://docs.wpvip.com/technical-references/caching/uncached-functions/#h-previously-uncached-wordpress-core-functions.

We should deprecate suggesting the below since it's no longer accurate:

VIP-Coding-Standards/WordPressVIPMinimum/Sniffs/Functions/RestrictedFunctionsSniff.php

Lines 286 to 291 in fbcc951

	'get_page_by_path' => [
	'type' => 'warning',
	'message' => '%s() is highly discouraged due to not being cached; please use wpcom_vip_get_page_by_path() instead.',
	'functions' => [
	'get_page_by_path',
	],

VIP-Coding-Standards/WordPressVIPMinimum/Sniffs/Functions/RestrictedFunctionsSniff.php

Lines 83 to 88 in fbcc951

	'get_page_by_title' => [
	'type' => 'error',
	'message' => '%s() is prohibited, please use wpcom_vip_get_page_by_title() instead.',
	'functions' => [
	'get_page_by_title',
	],

VIP-Coding-Standards/WordPressVIPMinimum/Sniffs/Functions/RestrictedFunctionsSniff.php

Lines 105 to 111 in fbcc951

	'term_exists' => [
	'type' => 'error',
	'message' => '%s() is highly discouraged due to not being cached; please use wpcom_vip_term_exists() instead.',
	'functions' => [
	'term_exists',
	],
	],

[GaryJones]

term_exists() was handled in #812.

[GaryJones]

get_page_by_title() has some interesting changes.

In https://core.trac.wordpress.org/ticket/36905 it was switched to use WP_Query internally, and thus now included caching for WP 6.1.

However, as of https://core.trac.wordpress.org/ticket/57041 and WP 6.2, this change was reverted, and the function became deprecated in favour of WP_Query.

This function deprecation is included in WPCS.

So now, the question becomes - should we:

• leave wpcom_vip_get_page_by_title() as the recommended solution
• update the error message for get_page_by_title() to recommend WP_Query (some what duplicating WPCS)
• remove all references to it and let folks use WPCS to be notified of it? If so, I've opened End restricting usage of get_page_by_title() #814.

[GaryJones]

get_page_by_path() did have a reliance on WP_Query, but that was reverted and as this time https://core.trac.wordpress.org/ticket/56689 is still open.

[GaryJones]

As the three functions have been addressed one way or another, this can be closed.