Skip to content

Backport: Block template utils and rest templates controller - #3221

Closed
ntsekouras wants to merge 20 commits into
WordPress:trunkfrom
ntsekouras:backport/expand-created-templates-site-editor
Closed

Backport: Block template utils and rest templates controller#3221
ntsekouras wants to merge 20 commits into
WordPress:trunkfrom
ntsekouras:backport/expand-created-templates-site-editor

Conversation

@ntsekouras

@ntsekourasntsekouras commented Sep 9, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

ntsekouras
ntsekouras commented Sep 9, 2022
View reviewed changes
Comment threadtests/phpunit/tests/rest-api/wpRestTemplatesController.php Outdated
@ntsekourasntsekouras mentioned this pull request Sep 9, 2022
Closed
37 tasks
@ntsekouras
ntsekourasforce-pushed the backport/expand-created-templates-site-editor branch from a2b4a3a to a3b7df7CompareSeptember 9, 2022 14:06
spacedmonkey
spacedmonkey reviewed Sep 9, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Outdated
@ntsekourasntsekouras mentioned this pull request Sep 12, 2022
Merged
@ntsekouras

ntsekouras commented Sep 12, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Do not merge before this GB PR: WordPress/gutenberg#44085

edit:

The GB PR has merged.

ockham
ockham reviewed Sep 14, 2022
View reviewed changes

@ockhamockham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @ntsekouras! This LGTM; however, we need to wait for Gutenberg 14.1 (which is the first release to contain WordPress/gutenberg#44085) to be released before merging this PR. Otherwise, a WP install running Core trunk and Gutenberg stable will fatal because of the duplicate get_template_hierarchy definition.

hellofromtonya
hellofromtonya requested changes Sep 15, 2022
View reviewed changes

@hellofromtonyahellofromtonya left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First pass through the code. Most changes requested are for compliance to Core's coding / testing standards and/or for consistency.

Comment threadsrc/wp-includes/block-template-utils.php
Comment threadsrc/wp-includes/block-template-utils.php
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Outdated
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Outdated
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Outdated
Comment threadtests/phpunit/tests/block-template-utils.php Outdated
Comment threadtests/phpunit/tests/rest-api/rest-post-types-controller.php Outdated
Comment threadtests/phpunit/tests/rest-api/wpRestTemplatesController.php Outdated
Comment threadtests/phpunit/tests/rest-api/wpRestTemplatesController.php Outdated
@hellofromtonya

hellofromtonya commented Sep 15, 2022

Copy link
Copy Markdown
Contributor

@spacedmonkey Are you happy with the REST code in this PR?

spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php Outdated
spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php
'icon' => array(
'description' => __( 'The icon for the post type.' ),
'type' => 'string',
'context' => array( 'view', 'edit', 'embed' ),

@spacedmonkeyspacedmonkeySep 20, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be in the view context? The icon is not public right now?

@ntsekourasntsekourasSep 20, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean public? I think it would be good to have in view as it can be useful in some cases. Do you see any drawback being in view context?

@spacedmonkeyspacedmonkeySep 20, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you make a property as view it means it can't be viewed pubilically. Do we want to expose this data publically?

@ntsekourasntsekourasSep 20, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see no harm in it, but if you have a strong opinion on this, I can remove it.

spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Outdated
}
$hierarchy = get_template_hierarchy( $request['slug'], $request['is_custom'], $request['template_prefix'] );
$fallback_template = resolve_block_template( $request['slug'], $hierarchy, '' );
return rest_ensure_response( $fallback_template );

@spacedmonkeyspacedmonkeySep 20, 2022•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
returnrest_ensure_response( $fallback_template );
$response = $this->prepare_item_for_response( $fallback_template, $request );
returnrest_ensure_response( $response );

Please ensure that response is run through prepare_item_for_response, so the response is formatted correctly.

@ntsekourasntsekourasSep 20, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll update but this change will also need a GB PR(therefore a packages update) to retrieve the content from content.raw.

@spacedmonkeyspacedmonkeySep 20, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the change and backport it. I can approve the change there as well. Change the properties / shape of response can / will cause problems down the road.

@ntsekourasntsekourasSep 20, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GB PR is here: WordPress/gutenberg#44299 --cc @ockham

spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Outdated
spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php Outdated
spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadtests/phpunit/tests/block-template-utils.php Outdated
spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadtests/phpunit/tests/rest-api/wpRestTemplatesController.php
spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php Outdated
@ockham

ockham commented Sep 20, 2022

Copy link
Copy Markdown
Contributor

Thank you @spacedmonkey and @ntsekouras!

Unfortunately, it seems like unit tests are failing:

1) Tests_REST_WpRestTemplatesController::test_get_template_fallback
Trying to get property 'slug' of non-object
/var/www/tests/phpunit/tests/rest-api/wpRestTemplatesController.php:766
phpvfscomposer:///var/www/vendor/phpunit/phpunit/phpunit:97
/var/www/vendor/bin/phpunit:118

spacedmonkey
spacedmonkey reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php
}

if ( in_array( 'icon', $fields, true ) ) {
$data['icon'] = $post_type->menu_icon;

@spacedmonkeyspacedmonkeySep 20, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this value is null, should it maybe default to something?

@ntsekourasntsekourasSep 20, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's okay to be null since it's not required and the consumers can decide what to do with it. For example in php core for post types we assign some default icon if it's in the admin menu, but in the site editor we assign different default icon..

@ntsekourasntsekouras mentioned this pull request Sep 20, 2022
Merged
@ockhamockham mentioned this pull request Sep 20, 2022
Closed
@hellofromtonyahellofromtonya self-assigned this Sep 20, 2022
@hellofromtonya

hellofromtonya commented Sep 20, 2022

Copy link
Copy Markdown
Contributor

Currently reviewing. When ready, will prep the commit.

hellofromtonya
hellofromtonya reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/block-template-utils.php Outdated
hellofromtonya
hellofromtonya reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/block-template-utils.php Outdated
hellofromtonya
hellofromtonya reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/block-template-utils.php
hellofromtonya
hellofromtonya reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/block-template-utils.php
hellofromtonya
hellofromtonya reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/block-template-utils.php Outdated
ntsekourasand others added 18 commits September 20, 2022 14:01
@ntsekouras@hellofromtonya
Backport: Block template utils and rest templates controller
e690417
@ntsekouras@hellofromtonya
add icon to types controller
a416a0a
@ntsekouras@hellofromtonya
update tests
f1958f4
@ntsekouras@hellofromtonya
add tests for is_wp_suggestion
0ae99e1
@hellofromtonya
Update docblock for coding standards
09ec609
@hellofromtonya
Remove 'gutenberg' text domain
1bf24b4
@hellofromtonya
Improve docblock for coding standards
adb4dca
@hellofromtonya
Removes "we" from description
d4a2bb8
@hellofromtonya
Auto regenerated wp-api-generated.js qunit test fixture
c63eb7d
@ntsekouras@hellofromtonya
update tests
06c0082
@ntsekouras@spacedmonkey@hellofromtonya
Update src/wp-includes/rest-api/endpoints/class-wp-rest-templates-con…
942ef32
…troller.php
Co-authored-by: Jonny Harris <spacedmonkey@users.noreply.github.com>
@ntsekouras@hellofromtonya
address feedback
2bdd393
@ntsekouras@hellofromtonya
feedback
2dcfe25
@ntsekouras@hellofromtonya
update tests and use rest_is_field_included
d0c2010
@ntsekouras@hellofromtonya
remove duplicate required
33a4eba
@hellofromtonya
Code review updates for get_template_hierarchy()
4ef9146
@hellofromtonya
Test updates get_template_hierarchy().
5deea6b
* Moved tests to its own test file.
* Moved individual assertions to a data provider.
@hellofromtonya
Updates to REST API tests
5ba2daf
@hellofromtonya
hellofromtonyaforce-pushed the backport/expand-created-templates-site-editor branch from 0bda281 to 5ba2dafCompareSeptember 20, 2022 19:12
@hellofromtonya

hellofromtonya commented Sep 20, 2022

Copy link
Copy Markdown
Contributor

Rebased the branch on top of the latest trunk.

@hellofromtonya
Reapply changeset 54184.
0d2d57c
After rebasing on top of trunk, the PR reverted some
of the changes in wp-includes/block-template-utils.php
that were added in changest 54184.
This commit reapplies the code from that changeset.
It also cleans up in one test.
hellofromtonya
hellofromtonya approved these changes Sep 20, 2022
View reviewed changes

@hellofromtonyahellofromtonya left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LTGM 👍 Ready for commit, which I'm prepping next.

@hellofromtonya

hellofromtonya commented Sep 20, 2022

Copy link
Copy Markdown
Contributor

Note: The npm CI job failure is unrelated to this PR.

hellofromtonya
hellofromtonya reviewed Sep 20, 2022
View reviewed changes
Comment threadsrc/wp-includes/block-template-utils.php Outdated
@hellofromtonya

hellofromtonya commented Sep 20, 2022

Copy link
Copy Markdown
Contributor

Committed via changeset https://core.trac.wordpress.org/changeset/54269. Thank you everyone for your contributions!

@ntsekourasntsekouras mentioned this pull request Feb 7, 2024
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ockhamockhamockham left review comments
@hellofromtonyahellofromtonyahellofromtonya approved these changes
@spacedmonkeyspacedmonkeyspacedmonkey approved these changes
@TimothyBJacobsTimothyBJacobsAwaiting requested review from TimothyBJacobs

Assignees

@hellofromtonyahellofromtonya

Labels

None yet

Projects

No open projects
WordPress 6.1 Editor Tasks
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ntsekouras@hellofromtonya@ockham@spacedmonkey