Skip to content

Docs: Add documentation for WordPress.Security.EscapeOutput #2585

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 2 commits into
base: develop
Choose a base branch
from
Open

Docs: Add documentation for WordPress.Security.EscapeOutput #2585

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1771933
Docs: add documentation for WordPress.Security.EscapeOutput
brentwilson-clariio Aug 26, 2025
78b67f7
Docs: reformat EscapeOutputStandard.xml to match docs style
brentwilson-clariio 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
46 changes: 46 additions & 0 deletions WordPress/Docs/Security/EscapeOutputStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?xml version="1.0"?>
<documentation title="Escape Output">
<standard>
<![CDATA[
Dynamic output must be escaped.

This sniff checks that any dynamic data sent to the browser
is escaped using a WordPress escaping function, such as
esc_html(), esc_attr(), or wp_kses_post(). Escaping prevents
cross-site scripting (XSS) vulnerabilities and ensures
output is safe.
]]>
</standard>

<code_comparison>
<code title="Invalid: unescaped echo">
<![CDATA[
<?php
$name = $_GET['name'];
echo <em>$name</em>;
]]>
</code>
<code title="Valid: escaped echo">
<![CDATA[
<?php
$name = $_GET['name'];
echo <em>esc_html( $name )</em>;
]]>
</code>
</code_comparison>

<code_comparison>
<code title="Invalid: unescaped printf">
<![CDATA[
<?php
printf( 'Hello %s', <em>$name</em> );
]]>
</code>
<code title="Valid: escaped printf">
<![CDATA[
<?php
printf( 'Hello %s', <em>esc_html( $name )</em> );
]]>
</code>
</code_comparison>
</documentation>
Loading