Create an alias get_element_class_name to use it in blocks #44099
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cbravobernal
requested review from
spacedmonkey,
michalczaplinski and
ajitbohra
as code owners
cbravobernal
commented
Sep 12, 2022
lib/compat/wordpress-6.1/theme.php
Outdated
Comment on lines
46
to
47
| if ( ! class_exists( 'WP_Theme_JSON_Gutenberg' ) || ! method_exists( 'WP_Theme_JSON_Gutenberg', 'get_element_class_name' ) ) { | ||
| return ''; |
There was a problem hiding this comment.
I'm not really sure if this case can happen.
There was a problem hiding this comment.
I don't think we use that in other places. The class and the method are present in the Gutenberg plugin so I belive you can skip the check.
|
Size Change: 0 B Total Size: 1.25 MB ℹ️ View Unchanged
|
cbravobernal
added
the
[Type] Code Quality
gziolo
reviewed
Sep 13, 2022
tools/webpack/blocks.js
Outdated
| @@ -30,6 +30,7 @@ const blockViewRegex = new RegExp( | |||
| const prefixFunctions = [ | |||
| 'build_query_vars_from_query_block', | |||
| 'wp_enqueue_block_support_styles', | |||
| 'wp_theme_element_class_name', | |||
There was a problem hiding this comment.
I would be happier if we wouldn't have to list those functions here. What's the reasoning behind using the function name with gutenberg_ prefix?
There was a problem hiding this comment.
That was my suggestion. I probably applied the conclusion from #43779 (comment) and the naming collision too strongly.
Since we're not dealing with a different version of the same function (as was the case in #43779, which was then superseded by #43859), it's probably fine to name it wp_theme_element_class_name in Gutenberg (and wrap the definition in a ! function_exists() check).
There was a problem hiding this comment.
Aside: @mtias has pointed out to me in Slack that
The one issue with the function check is that it prevents improvements on the plugin to the core functions
-- which was basically the situation we had in #43859. As we've discussed above, this doesn't currently apply to wp_theme_element_class_name -- if we ever decide to modify that function, we can still adopt a prefix-rewriting strategy.
We should probably put some guidelines into writing -- there currently seems to be a bit of confusion around what strategies to apply to avoid collisions (see e.g. #44100).
There was a problem hiding this comment.
There are guidelines present in the documentation:
https://github.com/WordPress/gutenberg/tree/trunk/lib#wrap-functions-and-classes-with--function_exists-and--class_exists
Feel free to add more details, so it makes the process less confusing.
I think there is rarely a reason to use the trick with webpack and prefixFunctions list. Two existing cases are related to the function param changes in the function definition. Otherwise, you can use all sorts of feature detection to figure out what needs to be polyfilled.
gziolo
approved these changes
Sep 13, 2022
gziolo
approved these changes
Sep 13, 2022
pento
pushed a commit
to WordPress/wordpress-develop
that referenced
this pull request
Sep 15, 2022
This changeset backports the `wp_theme_element_class_name()` alias for the "internal" `WP_Theme_JSON::get_element_class_name()` function. This is a backport of [WordPress/gutenberg#44099 gutenberg/PR44099]. Note: this changeset doesn't replace calls to `WP_Theme_JSON::get_element_class_name` in the tests, since those are specifically for the `WP_Theme_JSON` class. Props bernhard-reiter, cbravobernal, costdev. See #56467. git-svn-id: https://develop.svn.wordpress.org/trunk@54174 602fd350-edb4-49c9-b593-d223f7449a82
markjaquith
pushed a commit
to markjaquith/WordPress
that referenced
this pull request
Sep 15, 2022
This changeset backports the `wp_theme_element_class_name()` alias for the "internal" `WP_Theme_JSON::get_element_class_name()` function. This is a backport of [WordPress/gutenberg#44099 gutenberg/PR44099]. Note: this changeset doesn't replace calls to `WP_Theme_JSON::get_element_class_name` in the tests, since those are specifically for the `WP_Theme_JSON` class. Props bernhard-reiter, cbravobernal, costdev. See #56467. Built from https://develop.svn.wordpress.org/trunk@54174 git-svn-id: http://core.svn.wordpress.org/trunk@53733 1a063a9b-81f0-0310-95a4-ce76da25c4cd
github-actions bot
pushed a commit
to platformsh/wordpress-performance
that referenced
this pull request
Sep 15, 2022
This changeset backports the `wp_theme_element_class_name()` alias for the "internal" `WP_Theme_JSON::get_element_class_name()` function. This is a backport of [WordPress/gutenberg#44099 gutenberg/PR44099]. Note: this changeset doesn't replace calls to `WP_Theme_JSON::get_element_class_name` in the tests, since those are specifically for the `WP_Theme_JSON` class. Props bernhard-reiter, cbravobernal, costdev. See #56467. Built from https://develop.svn.wordpress.org/trunk@54174 git-svn-id: https://core.svn.wordpress.org/trunk@53733 1a063a9b-81f0-0310-95a4-ce76da25c4cd
whereiscodedude
pushed a commit
to whereiscodedude/wpss
that referenced
this pull request
Sep 18, 2022
This changeset backports the `wp_theme_element_class_name()` alias for the "internal" `WP_Theme_JSON::get_element_class_name()` function. This is a backport of [WordPress/gutenberg#44099 gutenberg/PR44099]. Note: this changeset doesn't replace calls to `WP_Theme_JSON::get_element_class_name` in the tests, since those are specifically for the `WP_Theme_JSON` class. Props bernhard-reiter, cbravobernal, costdev. See #56467. Built from https://develop.svn.wordpress.org/trunk@54174
ootwch
pushed a commit
to ootwch/wordpress-develop
that referenced
this pull request
Nov 4, 2022
This changeset backports the `wp_theme_element_class_name()` alias for the "internal" `WP_Theme_JSON::get_element_class_name()` function. This is a backport of [WordPress/gutenberg#44099 gutenberg/PR44099]. Note: this changeset doesn't replace calls to `WP_Theme_JSON::get_element_class_name` in the tests, since those are specifically for the `WP_Theme_JSON` class. Props bernhard-reiter, cbravobernal, costdev. See #56467. git-svn-id: https://develop.svn.wordpress.org/trunk@54174 602fd350-edb4-49c9-b593-d223f7449a82
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Creates an alias for the internal API class WP_Theme_JSON_Gutenberg
Why?
Following the discussion on Sync Gutenberg packages, we noticed that some blocks are using a Class WP_Theme_JSON_Gutenberg method.
How?
Testing Instructions
Go to post or site editor.
Add Search block or Comments Form block. Check that the button has
wp-element-buttonclass.Screenshots or screencast