Skip to content

WP/GlobalVariablesOverride: add XML documentation #2679

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.

Sign up for GitHub

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

Merged
dingo-d merged 6 commits into from
Jan 30, 2026
Merged

WP/GlobalVariablesOverride: add XML documentation #2679

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
60f36e3
Add GlobalVariableOverride standard doc
paulopmt1 Aug 26, 2025
0bb1f78
Apply suggestions from code review and a few more minor changes
rodrigoprimo Dec 24, 2025
1b67644
Apply suggestions from code review
rodrigoprimo Jan 28, 2026
c086eec
Wrap invalid example in a function following code review suggestion
rodrigoprimo Jan 28, 2026
13f028a
More changes to the invalid code examples discussed during PR review
rodrigoprimo Jan 28, 2026
ec70fbf
Add new version for the valid title suggested during code review
rodrigoprimo Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions WordPress/Docs/WP/GlobalVariablesOverrideStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Global Variables Override"
>
<standard>
<![CDATA[
Variables declared by WordPress in the global namespace should not be overridden by code extending WordPress.

Two WordPress global variables, `$content_width` and `$wp_cockneyreplace`, are
specifically intended to be overridden by themes/plugins and are exempt from this rule.
]]>
</standard>
<code_comparison>
<code title="Valid: Declaring global variables with names not reserved for use by WordPress itself.">
<![CDATA[
<em>$prefix_query</em> = new WP_Query( $args );

<em>$GLOBALS['prefix_data']</em> = 'some data';

foreach ( $selected_posts as <em>$prefix_post</em> ) {
// Do something.
}
]]>
</code>
<code title="Invalid: Overriding a WordPress defined global variable.">
<![CDATA[
function prefix_custom_query( $args ) {
<em>global $wp_query;</em>
<em>$wp_query</em> = new WP_Query( $args );

<em>$GLOBALS['post']</em> = get_post( 1 );
}

foreach ( $selected_posts as <em>$post</em> ) {
// Do something.
}
]]>
</code>
</code_comparison>
</documentation>
Loading