Rest API: rename navigation fallback classes from WP_ to Gutenberg_ by ramonjd · Pull Request #51959 · WordPress/gutenberg

ramonjd · 2023-06-27T08:04:20Z

What?

Renames /compat/wordpress-6.3/class-wp-rest-navigation-fallback-controller.php / WP_REST_Navigation_Fallback_Controller and associated classes/filenames to the class-gutenberg-* and Gutenberg_* conventions.

Why?

The WP_REST_Navigation_Fallback_Controller class has been committed to core and therefore results in a naming conflict and unit test failures.

By renaming to Gutenberg_* we can avoid naming conflicts while still supporting 6.3 functionality in the plugin for users that won't upgrade to WordPress 6.3.

How?

Renaming stuff.

Testing Instructions

The unit tests should pass.

… to core and therefore results in a naming conflict and unit test failures. Ideally `WP_REST_Navigation_Fallback_Controller` should have been named `WP_REST_Navigation_Fallback_Controller_Gutenberg` and extended `WP_REST_Navigation_Fallback_Controller`. But we can conditionally load the file instead.

…ock_Menu_Converter Load WP_REST_Navigation_Fallback_Controller dependencies in load.php

…oid compat errors and hopefully some confusion later.

talldan

Thanks @ramonjd.

Looks like this is the approach other gutenebrg REST classes take, and tests are passing, so looks good to me!

packages/block-library/src/navigation/index.php

talldan · 2023-06-27T09:29:07Z

I merged this with a failing performance test. That test checks out trunk and compares performance with this branch. When it checked out trunk it was re-encountering the issue that this PR fixes. I believe merging it should fix things.

getdave · 2023-06-27T11:08:31Z

Thanks for handling this. So for my reference:

When authoring class like these in Plugin always use class-gutenberg-* and Gutenberg_*.
When backporting change all those instances to class-wp-* and WP_*.
Put files in the directory for the release in which the features were backported to WP Core.

Question: is this documented? If not where could I contribute a docs update?

ramonjd · 2023-06-27T11:21:27Z

Hi @getdave

No worries. You've got it spot on.

This document covers most of this, though not as succinctly as you've put it: https://github.com/WordPress/gutenberg/blob/trunk/lib/README.md

Probably needs updating to include classes etc

getdave · 2023-06-27T11:24:21Z

This seems to say the opposite of what I said above.

Perhaps it should say use Gutenberg until the point at when it's merged to Core?

ramonjd · 2023-06-27T11:26:35Z

Oops, that document says:

For features that may be merged to Core, it's best to use a wp_ prefix for functions or a WP_ prefix for classes.

So you were just following orders :)

This probably needs to be cleared up. During release I don't think it's practical to juggle consistencies between plugin and Core where both have wp_, and renaming during backport isn't that hard.

🤷

Sorry for the confusion. Despite that doc I think experience has led us to the class-gutenberg-* road.

I'll add a note to raise it with @noisysocks

ramonjd · 2023-06-28T04:31:13Z

I just cherry-picked this PR to the release/16.1 branch to get it included in the next release: 5a32952

…51959) * The `WP_REST_Navigation_Fallback_Controller` class has been committed to core and therefore results in a naming conflict and unit test failures. Ideally `WP_REST_Navigation_Fallback_Controller` should have been named `WP_REST_Navigation_Fallback_Controller_Gutenberg` and extended `WP_REST_Navigation_Fallback_Controller`. But we can conditionally load the file instead. * Renamed WP_Classic_To_Block_Menu_Converter to Gutenberg_Classic_To_Block_Menu_Converter Load WP_REST_Navigation_Fallback_Controller dependencies in load.php * Renamed all 6.3 classes to have the Gutenberg_ prefix. This should avoid compat errors and hopefully some confusion later. * Also rename test files for completeness * Updated deprecation notices to refer to Gutenberg classes

* Restore sidebar in focus mode on Pattern click through in Browse Mode Library (#51897) Brings back #51492 * [Command center]: Add preferences and keyboard shortcuts commands (#51862) * [Command center]: Add preferences and keyboard shortcuts commands * update labels * [Site Editor]: Fix `library` command path (#51837) * Updating social link attributes (#51997) * Try: Update template titles (#51428) * Update template titles * Fix typo Co-authored-by: Alex Stine <alex.stine@yourtechadvisors.com> * Revert Index rename * "front page" -> "homepage" * Update 404 Page make more sense given the template appears in the Pages panel too. * Front Page * home title + description * Revert Home name change, and move compat files * separate code for wp versions * update tests --------- Co-authored-by: Alex Stine <alex.stine@yourtechadvisors.com> Co-authored-by: ntsekouras <ntsekouras@outlook.com> * Update text color (#51965) * Modal: Add small top padding to the content so that avoid cutting off the visible outline when hovering items (#51829) * Site Editor: Fix focus cutoff in add template modal * Add padding-top to the modal content * Remove unnecessary padding-top * Remove unnecessary padding-top * Update changelog * Revert top padding from block patterns list * Revert top padding from block patterns list * Remove unnecessary changes * Remove unnecessary changes * Add CSS inline comment * Change padding metrics * Rest API: rename navigation fallback classes from WP_ to Gutenberg_ (#51959) * The `WP_REST_Navigation_Fallback_Controller` class has been committed to core and therefore results in a naming conflict and unit test failures. Ideally `WP_REST_Navigation_Fallback_Controller` should have been named `WP_REST_Navigation_Fallback_Controller_Gutenberg` and extended `WP_REST_Navigation_Fallback_Controller`. But we can conditionally load the file instead. * Renamed WP_Classic_To_Block_Menu_Converter to Gutenberg_Classic_To_Block_Menu_Converter Load WP_REST_Navigation_Fallback_Controller dependencies in load.php * Renamed all 6.3 classes to have the Gutenberg_ prefix. This should avoid compat errors and hopefully some confusion later. * Also rename test files for completeness * Updated deprecation notices to refer to Gutenberg classes * Fix phpunit failures (#51950) * Fix phpunit failures * Add comment * Update comment with actual reason this fix works --------- Co-authored-by: Dave Smith <getdavemail@gmail.com> Co-authored-by: Nik Tsekouras <ntsekouras@outlook.com> Co-authored-by: Ramon <ramonjd@users.noreply.github.com> Co-authored-by: James Koster <james@jameskoster.co.uk> Co-authored-by: Alex Stine <alex.stine@yourtechadvisors.com> Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com> Co-authored-by: Robert Anderson <robert@noisysocks.com>

…ordPress#51959) * The `WP_REST_Navigation_Fallback_Controller` class has been committed to core and therefore results in a naming conflict and unit test failures. Ideally `WP_REST_Navigation_Fallback_Controller` should have been named `WP_REST_Navigation_Fallback_Controller_Gutenberg` and extended `WP_REST_Navigation_Fallback_Controller`. But we can conditionally load the file instead. * Renamed WP_Classic_To_Block_Menu_Converter to Gutenberg_Classic_To_Block_Menu_Converter Load WP_REST_Navigation_Fallback_Controller dependencies in load.php * Renamed all 6.3 classes to have the Gutenberg_ prefix. This should avoid compat errors and hopefully some confusion later. * Also rename test files for completeness * Updated deprecation notices to refer to Gutenberg classes

ramonjd requested a review from spacedmonkey as a code owner June 27, 2023 08:04

ramonjd self-assigned this Jun 27, 2023

ramonjd added [Type] Task Issues or PRs that have been broken down into an individual action to take [Type] Bug An existing feature does not function as intended labels Jun 27, 2023

Renamed WP_Classic_To_Block_Menu_Converter to Gutenberg_Classic_To_Bl…

ee38a17

…ock_Menu_Converter Load WP_REST_Navigation_Fallback_Controller dependencies in load.php

ramonjd requested review from getdave and talldan June 27, 2023 08:23

Renamed all 6.3 classes to have the Gutenberg_ prefix. This should av…

007f7fe

…oid compat errors and hopefully some confusion later.

ramonjd requested review from TimothyBJacobs and tellthemachines as code owners June 27, 2023 08:33

ramonjd changed the title ~~The WP_REST_Navigation_Fallback_Controller class has been committed…~~ Rest API: rename navigation fallback classes from WP_ to Gutenberg_ Jun 27, 2023

ramonjd added [Type] Plugin Interoperability Incompatibilities between a specific plugin and the block editor. Close with workaround notes. and removed [Type] Task Issues or PRs that have been broken down into an individual action to take labels Jun 27, 2023

talldan approved these changes Jun 27, 2023

View reviewed changes

oandregal reviewed Jun 27, 2023

View reviewed changes