Skip to content

[Update] Documentation for WP Alternative Functions #2588

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

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
+75 −0
Open

[Update] Documentation for WP Alternative Functions #2588

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0004bcc
Create WordPress.WP.AlternativeFunctions.xml
pamprn09 Sep 18, 2024
fc323f2
Moved File to proper location
bhubbard Aug 26, 2025
a2ee8e9
Removed incorrect nonce mention, added em tags
bhubbard Aug 26, 2025
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
75 changes: 75 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,75 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="WordPress Alternative Functions"
>
<standard>
<![CDATA[
Use WordPress functions instead of native PHP functions to maintain compatibility and benefit from WordPress's additional security and performance improvements.
]]>
</standard>
<code_comparison>
<code title="Valid: Using wp_json_encode() to encode JSON data.">
<![CDATA[
<em>wp_json_encode( $data );</em>
]]>
</code>
<code title="Invalid: Using PHP's json_encode() to encode JSON data.">
<![CDATA[
<em>json_encode( $data );</em>
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
WordPress provides the wp_remote_* functions for making HTTP requests. Avoid using file_get_contents() or cURL directly.
]]>
</standard>
<code_comparison>
<code title="Valid: Using wp_remote_get() for HTTP requests.">
<![CDATA[
$response = <em>wp_remote_get( $url );</em>
]]>
</code>
<code title="Invalid: Using file_get_contents() for HTTP requests.">
<![CDATA[
$response = <em>file_get_contents( $url );</em>
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Use WordPress's translation functions to ensure text is translatable and localized.
]]>
</standard>
<code_comparison>
<code title="Valid: Using _e() or __() for translatable text.">
<![CDATA[
<em>_e( 'Hello, World!', 'text-domain' );</em>
$hello = <em>__( 'Hello, World!', 'text-domain' );</em>
]]>
</code>
<code title="Invalid: Echoing plain text strings.">
<![CDATA[
<em>echo 'Hello, World!';</em>
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Always use WordPress functions for escaping output to prevent XSS vulnerabilities.
]]>
</standard>
<code_comparison>
<code title="Valid: Using esc_html() to escape HTML output.">
<![CDATA[
<em>echo esc_html( $user_input );</em>
]]>
</code>
<code title="Invalid: Outputting user input without escaping.">
<![CDATA[
<em>echo $user_input;</em>
]]>
</code>
</code_comparison>
</documentation>
Loading