Custom CSS: add deprecation warning in codebase #37163
Conversation
github-actions
bot
added
[Plugin] Jetpack
|
Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.
Interested in more tips and information?
|
|
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖 The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available. Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped. Jetpack plugin: The Jetpack plugin has different release cadences depending on the platform:
If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack. |
| @@ -26,6 +26,8 @@ function jetpack_load_custom_css() { | |||
| * Enable CSS module. | |||
| */ | |||
| function custom_css_loaded() { | |||
| _deprecated_hook( 'custom_css_loaded', 'jetpack-$$next-version$$', 'WordPress Custom CSS', 'Jetpack no longer supports Custom CSS. Read the WordPress.org documentation to learn how to apply custom styles to your site: https://wordpress.org/documentation/article/styles-overview/#applying-custom-css' ); | |||
There was a problem hiding this comment.
The _deprecated_hook is useful here as it lets us define an optional message (unlike _deprecated_function, for instance).
There was a problem hiding this comment.
Should we make this message translatable? It may prove useful to raise the attention of non english speakers?
monsieur-z
force-pushed
the
update/custom-css-to-mu-wpcom
branch
from
9eb2b78 to
08e225b
Compare
| @@ -28,7 +28,7 @@ function jetpack_load_custom_css() { | |||
| function custom_css_loaded() { | |||
| _deprecated_hook( | |||
| 'custom_css_loaded', | |||
| 'jetpack-$$next-version$$', | |||
| '$$next-version$$', | |||
There was a problem hiding this comment.
This is what is causing the build to fail at the moment (with an 'Unexpected $$next-version$$ token' error).
For this to work, everything needs to be on one line as per the docs here - https://github.com/Automattic/jetpack/blob/trunk/projects/packages/README.md#package-version-annotations:
So this should work:
// translators: %s is a link to the WordPress.org documentation.
_deprecated_hook( 'custom_css_loaded', 'jetpack-$$next-version$$', 'WordPress Custom CSS', sprintf( esc_html__( 'Jetpack no longer supports Custom CSS. Read the WordPress.org documentation to learn how to apply custom styles to your site: %s', 'jetpack' ), 'https://wordpress.org/documentation/article/styles-overview/#applying-custom-css' ) );
Possibly adding the translatable string to a variable to then make it more readable.
There was a problem hiding this comment.
Thanks! I was wondering why this was failing.
* Custom CSS: add deprecation warning in codebase * Localize deprecation message * Fix version placeholder * Fix failing build --------- Co-authored-by: Karen Attfield <[email protected]>
Proposed changes:
The Custom CSS feature will soon be deprecated from Jetpack.
This PR ensures the codebase issues a deprecation warning when loading the Custom CSS module.
Other information:
Jetpack product discussion
pfwV0U-4M-p2
Does this pull request change what data or activity we track or use?
No.
Testing instructions:
/wp-admin/admin.php?page=jetpack#/settings?term=css/wp-admin/admin.php?page=jetpack#/dashboardHook custom_css_loaded is deprecated since version jetpack-$$next-version$$! Use WordPress Custom CSS instead. Jetpack no longer supports Custom CSS...