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

Refactoring - wp-paths-sizes #7445

Closed

Conversation

apermo
Copy link

@apermo apermo commented Sep 27, 2024

Changed: Moving $info['wp-paths-sizes'] to own function


Follow up to #7027 as discussed with @dmsnell and @costdev

Summary of the coming steps:

  1. wp-filesystem
  2. wp-constants
  3. wp-database
  4. wp-server
  5. wp-media
  6. wp-plugins-active & wp-plugins-inactive
  7. wp-mu-plugins
  8. wp-themes-inactive
  9. wp-parent-theme
  10. wp-active-theme
  11. wp-dropins
  12. wp-paths-sizes (we are here)
  13. wp-core

Refactoring WP_Debug_Data::debug_data(); into smaller functions for

  • better maintainability
  • reduced complexity
  • preparation for future unit tests
  • improved extensibility (see trac for details)
  • added php7.2 style type hints
  • fixed an error with $parent_theme_auto_update_string showing the value from $auto_updates_string (This will be handled only in Step 9)

Trac ticket: https://core.trac.wordpress.org/ticket/61648#ticket


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.

Moved wp-paths-sizes definition to get_wp_paths_sizes()
Fixed phpdoc for get_wp_mu_plugins()
Copy link

github-actions bot commented Sep 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.

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

Props apermo, dmsnell.

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

Copy link

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.

@dmsnell
Copy link
Member

dmsnell commented Oct 4, 2024

@apermo I proposed an alternative mechanism for removing sections. please let me know what you think of it. this change is bigger, and as experience tells us, more sensitive to review. but I think ultimately it will be nice to give the new methods the ability to remove their own section, and helps avoid recreating the stack of conditionals for section inclusion or removal. in other words, it encourages keeping the logic for each section local to that section.

@apermo
Copy link
Author

apermo commented Oct 5, 2024

Makes sense and is more flexible in the future.

pento pushed a commit that referenced this pull request Oct 5, 2024
This is the tenth part in a larger modularization of the data in `WP_Debug_Data`. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other.

This patch separates the eleventh of twelve groups, the `wp-paths-sizes` info, into a separate method focused on that data.

This work precedes changes to make the `WP_Debug_Data` class more extensible for better use by plugin and theme code.

Developed in #7445
Discussed in https://core.trac.wordpress.org/ticket/61648

Props apermo, dmsnell.
See #61648.


git-svn-id: https://develop.svn.wordpress.org/trunk@59175 602fd350-edb4-49c9-b593-d223f7449a82
@dmsnell
Copy link
Member

dmsnell commented Oct 5, 2024

Merged in [59175]
2859999

@dmsnell dmsnell closed this Oct 5, 2024
@dmsnell dmsnell deleted the refactor-wp-debug-data/paths-sizes branch October 5, 2024 16:27
markjaquith pushed a commit to markjaquith/WordPress that referenced this pull request Oct 5, 2024
This is the tenth part in a larger modularization of the data in `WP_Debug_Data`. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other.

This patch separates the eleventh of twelve groups, the `wp-paths-sizes` info, into a separate method focused on that data.

This work precedes changes to make the `WP_Debug_Data` class more extensible for better use by plugin and theme code.

Developed in WordPress/wordpress-develop#7445
Discussed in https://core.trac.wordpress.org/ticket/61648

Props apermo, dmsnell.
See #61648.

Built from https://develop.svn.wordpress.org/trunk@59175


git-svn-id: http://core.svn.wordpress.org/trunk@58570 1a063a9b-81f0-0310-95a4-ce76da25c4cd
github-actions bot pushed a commit to gilzow/wordpress-performance that referenced this pull request Oct 5, 2024
This is the tenth part in a larger modularization of the data in `WP_Debug_Data`. Previously this was a single massive method drawing in debug data from various groups of related data, where the groups were independent from each other.

This patch separates the eleventh of twelve groups, the `wp-paths-sizes` info, into a separate method focused on that data.

This work precedes changes to make the `WP_Debug_Data` class more extensible for better use by plugin and theme code.

Developed in WordPress/wordpress-develop#7445
Discussed in https://core.trac.wordpress.org/ticket/61648

Props apermo, dmsnell.
See #61648.

Built from https://develop.svn.wordpress.org/trunk@59175


git-svn-id: https://core.svn.wordpress.org/trunk@58570 1a063a9b-81f0-0310-95a4-ce76da25c4cd
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.

2 participants