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

Rename wp_should_load_separate_core_block_assets function to wp_shoul… #7489

Open
wants to merge 10 commits into
base: trunk
Choose a base branch
from

Conversation

Debarghya-Banerjee
Copy link

Trac ticket: Core-61958

Summary

  • This pull request addresses the confusion surrounding the wp_should_load_separate_core_block_assets() function and the should_load_separate_core_block_assets filter, both introduced in WordPress 5.8. The goal is to clarify their purpose and improve the documentation.

Background

  • Initially, the wp_should_load_separate_core_block_assets() function and its associated filter were intended to determine whether individual block stylesheets for core blocks should be loaded, as opposed to the single wp-block-library stylesheet. However, their purpose has evolved to control the loading of block assets on demand, including for third-party blocks. This change has led to inconsistencies in naming and documentation, which have caused confusion among developers.

Key Changes

Function and Filter Renaming

  • The old function wp_should_load_separate_core_block_assets() has been deprecated and replaced with wp_should_load_block_assets_on_demand().

  • The associated filter has also been renamed accordingly.

Deprecation Implementation:

  • The deprecated function has been moved to deprecated.php to maintain backward compatibility while encouraging developers to transition to the new function.

Codebase Updates:

  • All instances of the old function have been replaced with the new function and filter throughout the core codebase.

  • Documentation Updates: The documentation for the new function and filter has been updated to clearly outline their purpose, focusing on the loading of block assets on demand and the implications for core block stylesheets.

Benefits:

  • Enhanced clarity and consistency in the naming and documentation of functions and filters.

  • Improved performance by allowing for conditional loading of block assets.

  • A smoother transition for developers by maintaining backward compatibility through deprecation.

…d_load_block_assets_on_demand and replace the deprecated function
Copy link

github-actions bot commented Oct 3, 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.

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

Props debarghyabanerjee.

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 Oct 3, 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.

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.

1 participant