Deprecate wp_enqueue_block_support_styles #4015

andrewserong · 2023-02-07T00:52:23Z

In 6.2, once the JS packages have been updated, which includes changes to core blocks' index.php files, all usage in core of wp_enqueue_block_support_styles will have been removed. It should then be possible to deprecate wp_enqueue_block_support_styles as a function.

Since the style engine classes were added in 6.1, the style engine is now a better way to enqueue block support styles, as styles can be registered in multiple places, with those styles grouped together to be output only a single time, whereas wp_enqueue_block_support_styles resulted in multiple <style> tags being output on the site frontend (one for each instance of a block support being rendered), along with redundant style output.

Note: this PR should only land after the JS packages update that includes the changes to the gallery block, which roll in this PR: WordPress/gutenberg#43070. Without that, then you if a request a post or page containing a Gallery block, the following will be logged, as the gallery block in trunk currently still contains a call to wp_enqueue_block_support_styles:

Trac ticket: https://core.trac.wordpress.org/ticket/57647

CC: @Mamaduka

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

andrewserong · 2023-02-07T01:07:34Z

Note: the failing PHP tests are expected here! Once the JS packages update has been completed, this PR should be rebased against trunk and the following test failures should no longer occur:

1) Tests_Blocks_Render::test_do_block_output with data set #21 ('core__gallery.html', 'core__gallery.server.html')
Unexpected deprecation notice for wp_enqueue_block_support_styles.
Function wp_enqueue_block_support_styles is deprecated since version 6.2.0! Use wp_style_engine_get_stylesheet_from_css_rules() instead.
Failed asserting that an array is empty.

2) Tests_Blocks_Render::test_do_block_output with data set #22 ('core__gallery__columns.html', 'core__gallery__columns.server.html')
Unexpected deprecation notice for wp_enqueue_block_support_styles.
Function wp_enqueue_block_support_styles is deprecated since version 6.2.0! Use wp_style_engine_get_stylesheet_from_css_rules() instead.
Failed asserting that an array is empty.

mukeshpanchal27

Thanks @andrewserong, PR looks good to me and ready for merge when the package updated. Great work!

Mamaduka · 2023-02-07T04:36:03Z

Thank you, @andrewserong!

The PR will need to be rebased after #3914 is merged to fix PHPUnit tests.

ntsekouras

Thank you @andrewserong ! I tested here and verified that the deprecation message is shown. Also tested against current trunk with the packages update and there is no warning.

andrewserong · 2023-02-07T22:25:40Z

Update: even thought the tests are now passing, it looks like this PR is likely not going to be viable in time as a recently backported feature (#4013) appears to also use wp_enqueue_block_support_styles. From my perspective, there's no urgency in deprecating the feature, this PR can happily wait (or be parked) until there's no longer any calls to the function. Or, alternately, it's okay to keep the function around as a not-deprecated function if there's a valid use for the existing behaviour.

Mamaduka · 2023-02-08T05:40:47Z

Thank you, @andrewserong!

hellofromtonya

There is an instance of this function being used in Core in _wp_add_block_level_preset_styles() function https://github.com/WordPress/wordpress-develop/blob/trunk/src/wp-includes/block-supports/settings.php#L139 (from changeset 55255).

This should also be changed if this function is to be deprecated.

hellofromtonya · 2023-02-13T21:12:57Z

src/wp-includes/script-loader.php

@@ -2998,6 +2999,7 @@ function wp_enqueue_global_styles_css_custom_properties() {
 * @param int    $priority To set the priority for the add_action.
 */
 function wp_enqueue_block_support_styles( $style, $priority = 10 ) {


This function should be moved to wp-includes/deprecated.php.

hellofromtonya · 2023-02-13T21:14:04Z

src/wp-includes/script-loader.php

@@ -2998,6 +2999,7 @@ function wp_enqueue_global_styles_css_custom_properties() {
 * @param int    $priority To set the priority for the add_action.
 */
 function wp_enqueue_block_support_styles( $style, $priority = 10 ) {
+	_deprecated_function( __FUNCTION__, '6.2.0', 'wp_style_engine_get_stylesheet_from_css_rules()' );
 	$action_hook_name = 'wp_footer';


Suggested change

$action_hook_name = 'wp_footer';

$action_hook_name = 'wp_footer';

Empty new line to separate the deprecation from the original function's code.

andrewserong · 2023-02-13T22:08:45Z

Thanks for reviewing @hellofromtonya — I think this PR is stalled right now due to #4013 landing after I opened this PR. I added a comment to that PR with some feedback about possible next steps: #4013 (comment).

Given the timing, and that I don't think refactoring that usage would be very straightforward, I think we should probably park this deprecation proposal for the time being. I can close out this PR if it keeps things neater 🙂

spacedmonkey · 2023-06-20T14:47:13Z

src/wp-includes/script-loader.php

@@ -2998,6 +2999,7 @@ function wp_enqueue_global_styles_css_custom_properties() {
 * @param int    $priority To set the priority for the add_action.
 */
 function wp_enqueue_block_support_styles( $style, $priority = 10 ) {
+	_deprecated_function( __FUNCTION__, '6.2.0', 'wp_style_engine_get_stylesheet_from_css_rules()' );


Suggested change

_deprecated_function( __FUNCTION__, '6.2.0', 'wp_style_engine_get_stylesheet_from_css_rules()' );

_deprecated_function( __FUNCTION__, '6.3.0', 'wp_style_engine_get_stylesheet_from_css_rules()' );

spacedmonkey · 2023-06-20T14:47:19Z

src/wp-includes/script-loader.php

@@ -2988,6 +2988,7 @@ function wp_enqueue_global_styles_css_custom_properties() {
 *
 * @since 5.9.1
 * @since 6.1.0 Added the `$priority` parameter.
+ * @deprecated 6.2.0 Use wp_style_engine_get_stylesheet_from_css_rules() instead.


Suggested change

* @deprecated 6.2.0 Use wp_style_engine_get_stylesheet_from_css_rules() instead.

* @deprecated 6.3.0 Use wp_style_engine_get_stylesheet_from_css_rules() instead.

andrewserong mentioned this pull request Feb 7, 2023

Gallery: register styles with style engine WordPress/gutenberg#43070

Merged

andrewserong mentioned this pull request Feb 7, 2023

Plugin: Backport PHP changes for WordPress 6.2 release WordPress/gutenberg#47187

Closed

85 tasks

mukeshpanchal27 approved these changes Feb 7, 2023

View reviewed changes

ntsekouras approved these changes Feb 7, 2023

View reviewed changes

Mamaduka mentioned this pull request Feb 7, 2023

Update: Backport block settings to core. #4013

Closed

Deprecate wp_enqueue_block_support_styles

a7aa10f

andrewserong force-pushed the try/deprecate-wp-enqueue-block-support-styles branch from 851c78c to a7aa10f Compare February 7, 2023 22:09

hellofromtonya requested changes Feb 13, 2023

View reviewed changes

spacedmonkey reviewed Jun 20, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate wp_enqueue_block_support_styles #4015

Deprecate wp_enqueue_block_support_styles #4015

andrewserong commented Feb 7, 2023

andrewserong commented Feb 7, 2023

mukeshpanchal27 left a comment

Mamaduka commented Feb 7, 2023

ntsekouras left a comment

andrewserong commented Feb 7, 2023

Mamaduka commented Feb 8, 2023

hellofromtonya left a comment

hellofromtonya Feb 13, 2023

hellofromtonya Feb 13, 2023

andrewserong commented Feb 13, 2023

spacedmonkey Jun 20, 2023

spacedmonkey Jun 20, 2023

	$action_hook_name = 'wp_footer';

	$action_hook_name = 'wp_footer';

	_deprecated_function( __FUNCTION__, '6.2.0', 'wp_style_engine_get_stylesheet_from_css_rules()' );
	_deprecated_function( __FUNCTION__, '6.3.0', 'wp_style_engine_get_stylesheet_from_css_rules()' );

	* @deprecated 6.2.0 Use wp_style_engine_get_stylesheet_from_css_rules() instead.
	* @deprecated 6.3.0 Use wp_style_engine_get_stylesheet_from_css_rules() instead.

Deprecate wp_enqueue_block_support_styles #4015

Are you sure you want to change the base?

Deprecate wp_enqueue_block_support_styles #4015

Conversation

andrewserong commented Feb 7, 2023

andrewserong commented Feb 7, 2023

mukeshpanchal27 left a comment

Choose a reason for hiding this comment

Mamaduka commented Feb 7, 2023

ntsekouras left a comment

Choose a reason for hiding this comment

andrewserong commented Feb 7, 2023

Mamaduka commented Feb 8, 2023

hellofromtonya left a comment

Choose a reason for hiding this comment

hellofromtonya Feb 13, 2023

Choose a reason for hiding this comment

hellofromtonya Feb 13, 2023

Choose a reason for hiding this comment

andrewserong commented Feb 13, 2023

spacedmonkey Jun 20, 2023

Choose a reason for hiding this comment

spacedmonkey Jun 20, 2023

Choose a reason for hiding this comment