Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add default return value to the WP_REST_Templates_Controller::get_wp_templates_author_text_field() method #7000

Conversation

anton-vlasenko
Copy link

@anton-vlasenko anton-vlasenko commented Jul 9, 2024

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


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.

Copy link

github-actions bot commented Jul 9, 2024

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@@ -865,6 +865,7 @@ private static function get_wp_templates_author_text_field( $template_object ) {
case 'site':
return get_bloginfo( 'name' );
case 'user':
default:
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the idea of making this code future-proof. But I'm thinking a better approach is to decouple the 2 methods.

How so?

Right now, get_wp_templates_original_source_field() returns one of the specific cases that are already covered here. What happens if that method gets changed, but changes are not reflected in this method?

I suggest instead of making the default use the user, instead, return an empty string at the end of the method. This return provides a graceful fallback or fallthrough.

return '';

What do you think @anton-vlasenko ?

Copy link
Author

Choose a reason for hiding this comment

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

Well spotted, @hellofromtonya!
Thank you for the review.
Initially, I had the same idea but can't recall why I chose the other option.
Fixed in 96b5d55.

@anton-vlasenko anton-vlasenko marked this pull request as ready for review July 10, 2024 10:37
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props antonvlasenko, hellofromtonya.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Contributor

@hellofromtonya hellofromtonya left a comment

Choose a reason for hiding this comment

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

LGTM for commit.

@hellofromtonya
Copy link
Contributor

Committed via https://core.trac.wordpress.org/changeset/58705. Thanks everyone for your contributions

@anton-vlasenko
Copy link
Author

Committed via https://core.trac.wordpress.org/changeset/58705. Thanks everyone for your contributions

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants