Skip to content

WP/AlternativeFunctions: add XML documentation #2687

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
GaryJones merged 5 commits into from
Feb 24, 2026
Merged

WP/AlternativeFunctions: add XML documentation #2687

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df427c7
WP/AlternativeFunctions: add XML documentation
pamprn09 Sep 18, 2024
a1e0e5d
Apply changes suggested during PR review and a few more
rodrigoprimo Jan 30, 2026
89b4c19
Use a single code comparison with one representative example
rodrigoprimo Feb 3, 2026
ebc0db8
Explain why WP alternatives should be preferred in the standard descr…
rodrigoprimo Feb 5, 2026
290ac34
Use an unconditionally flagged function in the code example
rodrigoprimo Feb 23, 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
25 changes: 25 additions & 0 deletions WordPress/Docs/WP/AlternativeFunctionsStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Alternative Functions"
>
<standard>
<![CDATA[
Use WordPress functions instead of certain native PHP functions.

These WordPress functions typically improve consistency across different PHP versions, operating systems, and server configurations, and/or provide a more comprehensive or robust version of the PHP native function. Using them can make the code more portable and reliable.
]]>
</standard>
<code_comparison>
<code title="Valid: Using a WordPress alternative function.">
<![CDATA[
$number = <em>wp_rand</em>( 1, 100 );
]]>
</code>
<code title="Invalid: Using a discouraged PHP function.">
<![CDATA[
$number = <em>mt_rand</em>( 1, 100 );
]]>
</code>
</code_comparison>
</documentation>
Loading