-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Docs: Systematically add missing @global annotations for global variables #10864
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
base: trunk
Are you sure you want to change the base?
Docs: Systematically add missing @global annotations for global variables #10864
Conversation
|
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
|
@noruzzamans Looks good. i have suggest minor changes. |
fe33019 to
f06eb08
Compare
…bles **Trac Ticket:** https://core.trac.wordpress.org/ticket/64224 **Why this change?** This change adds missing @global documentation tags to functions in - src/wp-admin/includes/misc.php - src/wp-admin/includes/template.php - src/wp-admin/includes/schema.php - src/wp-admin/install.php This aligns the codebase with the WordPress PHP Documentation Standards, ensuring that global variables used within functions are properly documented for better static analysis and code clarity. Files Changed: - src/wp-admin/includes/misc.php - src/wp-admin/includes/template.php - src/wp-admin/includes/schema.php - src/wp-admin/install.php
f06eb08 to
362dd81
Compare
src/wp-admin/includes/template.php
Outdated
| * @type string $section_class The class name to use for the section. Default empty. | ||
| * } | ||
| * | ||
| * @global array $wp_settings_sections Global settings sections array. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@noruzzamans Thanks for the PR.
@global tag should add before param
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shail-mehta nice catch thanks.
…n in Twenty Fifteen functions.php
…n back-compat.php
|
@noruzzamans Please exclude the bundled theme changes, as they are already being tracked in a separate ticket. #58715 |
Trac Ticket: https://core.trac.wordpress.org/ticket/64224
Why this change?
This change adds missing @global documentation tags
This aligns the codebase with the WordPress PHP Documentation Standards, ensuring that global variables used within functions are properly documented for better static analysis and code clarity.