Skip to content

Doc block fix for WP_Block_Patterns_Registry::register#6191

Closed
kt-12 wants to merge 5 commits intoWordPress:trunkfrom
10up:fix/doc-block-59532
Closed

Doc block fix for WP_Block_Patterns_Registry::register#6191
kt-12 wants to merge 5 commits intoWordPress:trunkfrom
10up:fix/doc-block-59532

Conversation

@kt-12
Copy link
Copy Markdown
Member

@kt-12 kt-12 commented Feb 27, 2024

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


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.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 27, 2024

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @jonnynews.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Props thekt12, joemcgill.

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

Copy link
Copy Markdown
Member

@joemcgill joemcgill left a comment

Choose a reason for hiding this comment

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

Good update. The $content property should be updated to say that it is no longer required if there is a $file_path present. It would probably be good to move the new property up to just after $content as well, since they are so closely related. What do you think?

@github-actions
Copy link
Copy Markdown

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.

Copy link
Copy Markdown
Member

@joemcgill joemcgill left a comment

Choose a reason for hiding this comment

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

After looking at this again, @kt-12 and I realized that the new property is the only one using snake case instead of camel case. Let's go ahead and fix those now for consistency and add, a @since annotation to the register method here.

 * @since 6.5.0 Added support for the `filePath` property.

Copy link
Copy Markdown
Member

@joemcgill joemcgill left a comment

Choose a reason for hiding this comment

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

🙏🏻 Thanks!

@joemcgill
Copy link
Copy Markdown
Member

@joemcgill joemcgill closed this Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants