Skip to content

WP/GlobalVariablesOverride: add XML documentation#2679

Merged
dingo-d merged 6 commits intoWordPress:developfrom
rodrigoprimo:docs-global-variables-override
Jan 30, 2026
Merged

WP/GlobalVariablesOverride: add XML documentation#2679
dingo-d merged 6 commits intoWordPress:developfrom
rodrigoprimo:docs-global-variables-override

Conversation

@rodrigoprimo
Copy link
Copy Markdown
Collaborator

@rodrigoprimo rodrigoprimo commented Dec 24, 2025

Description

This PR adds XML documentation for the WordPress.WP.GlobalVariablesOverride sniff.

The documentation is based on the work started by @paulopmt1 in #2586. I squashed the original commits and, in a separate commit, made subsequent changes based on the review left in #2586.

I suggest squashing those two commits before merging. I'm opening the PR without doing that to make it easier to tell my changes apart from the original changes.

Suggested changelog entry

N/A

Related issues/external references

Related to: #1722
Supersedes: #2586
Closes #2586

Copy link
Copy Markdown
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

Thanks for picking this one up @rodrigoprimo ! Left some comments to consider inline.

@rodrigoprimo
Copy link
Copy Markdown
Collaborator Author

Thanks for your review, @jrfnl! I implemented your suggestions and proposed two shorter alternatives to the valid title. This PR is ready for another look when you get a chance.

@jrfnl jrfnl added this to the 3.3.x milestone Jan 29, 2026
Copy link
Copy Markdown
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

Thanks @rodrigoprimo ! I think this one is ready for merge.

@jrfnl
Copy link
Copy Markdown
Member

jrfnl commented Jan 29, 2026

Note for the second reviewer: please squash-merge this PR.

@dingo-d dingo-d merged commit fa02bc4 into WordPress:develop Jan 30, 2026
31 checks passed
@rodrigoprimo rodrigoprimo deleted the docs-global-variables-override branch February 2, 2026 16:56
@jrfnl jrfnl modified the milestones: 3.3.x, 3.4.0 Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants