Skip to content

PHP/DevelopmentFunctions: add XML documentation #2690

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 4 commits into from
Feb 4, 2026
Merged

PHP/DevelopmentFunctions: add XML documentation #2690

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ff792c
Add documentation for WordPress.PHP.DevelopmentFunctions
gogdzl Sep 17, 2024
0ea73de
Apply suggestions from PR review
rodrigoprimo Feb 2, 2026
e5ecb4f
Remove code comparisons and add example functions to standard descrip…
rodrigoprimo Feb 3, 2026
7be82d2
Merge standard blocks into a single block
rodrigoprimo Feb 3, 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
40 changes: 40 additions & 0 deletions WordPress/Docs/PHP/DevelopmentFunctionsStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Development Functions"
>
<standard>
<![CDATA[
Debug functions should not be used in production code.
]]>
</standard>
<code_comparison>
<code title="Valid: Not using debug functions.">
<![CDATA[
// Code without debug functions.
]]>
</code>
<code title="Invalid: Calling a debug function.">
<![CDATA[
<em>var_dump( $bar );</em>
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Functions that can lead to full path disclosure should not be used.
]]>
</standard>
<code_comparison>
<code title="Valid: Not using functions that can lead to full path disclosure.">
<![CDATA[
// No full path disclosure functions.
]]>
</code>
<code title="Invalid: Using a function that can lead to full path disclosure.">
<![CDATA[
<em>phpinfo();</em>
]]>
</code>
</code_comparison>
</documentation>
Loading