Skip to content

PHP/PregQuoteDelimiter: add XML documentation #2677

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 1 commit into from
Dec 27, 2025
+35 −0
Merged

PHP/PregQuoteDelimiter: add XML documentation #2677

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 35 additions & 0 deletions WordPress/Docs/PHP/PregQuoteDelimiterStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Preg Quote Delimiter"
>
<standard>
<![CDATA[
Passing the $delimiter parameter to `preg_quote()` is strongly recommended to ensure the regular expression delimiter is properly escaped if it occurs in the input string.
]]>
</standard>
<code_comparison>
<code title="Valid: The delimiter parameter is passed.">
<![CDATA[
// $input = 'my #1 fan!';
$quoted_input = preg_quote( $input, <em>'#'</em> );
preg_match(
<em>'#^' . $quoted_input . '#i'</em>,
$post_content,
$matches
);
]]>
</code>
<code title="Invalid: The delimiter parameter is missing.">
<![CDATA[
// $input = 'my #1 fan!';
$quoted_input = preg_quote( $input<em></em> );
preg_match(
<em>'#^' . $quoted_input . '#i'</em>,
$post_content,
$matches
);
]]>
</code>
</code_comparison>
</documentation>
Loading