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

Removing PHP notice for non pattern definition files #8631

Conversation

webmandesign
Copy link

Skipping non-pattern-definition PHP files within theme-slug/patterns folder during block pattern registration.
This allows using helper PHP files within theme-slug/patterns folder, keeping pattern related code in the theme together.

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


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 Apr 1, 2025

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 webmandesign, joemcgill, jorbin.

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

Copy link

github-actions bot commented Apr 1, 2025

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
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.

@webmandesign Thanks for the updates here. I've left a bit of feedback, but this looks pretty good to me.

/**
* Filters list of block pattern files for a theme.
*
* @since 6.8
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* @since 6.8
* @since 6.8.0

* @param array $files Array of theme files found within `patterns` directory.
* @param string $dirpath Path of theme `patterns` directory being scanned.
*/
$files = (array) apply_filters( 'get_block_patterns_files', $files, $dirpath );
Copy link
Member

Choose a reason for hiding this comment

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

Let's rename this to be a bit more consistent with other filters in this file:

Suggested change
$files = (array) apply_filters( 'get_block_patterns_files', $files, $dirpath );
$files = (array) apply_filters( 'theme_block_pattern_files', $files, $dirpath );

@@ -1893,6 +1903,10 @@ public function get_block_patterns() {
foreach ( $files as $file ) {
$pattern = get_file_data( $file, $default_headers );

if ( empty( $pattern['slug'] ) && empty( $pattern['title'] ) ) {
Copy link
Member

Choose a reason for hiding this comment

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

I think this makes sense to add here. The downside may be that folks forget to add the header and have their patterns silently fail to load.

Copy link
Author

Choose a reason for hiding this comment

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

You are right. I'm going to remove this code.

* @param array $files Array of theme files found within `patterns` directory.
* @param string $dirpath Path of theme `patterns` directory being scanned.
*/
$files = (array) apply_filters( 'get_block_patterns_files', $files, $dirpath );
Copy link
Member

Choose a reason for hiding this comment

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

Casting as an array could hide if someone returns the wrong type which can make it harder to debug.

Suggested change
$files = (array) apply_filters( 'get_block_patterns_files', $files, $dirpath );
$files = apply_filters( 'get_block_patterns_files', $files, $dirpath );

Copy link

github-actions bot commented Apr 8, 2025

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 60142
GitHub commit: 6511cc0

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Apr 8, 2025
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