Skip to content

PHP/NoSilencedErrors: add XML documentation #2694

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

PHP/NoSilencedErrors: add XML documentation #2694

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c9c7a49
Add documentation for WordPress.PHP.NoSilencedErrors
gogdzl Sep 17, 2024
8c47d85
Apply changes suggested during PR review
rodrigoprimo Feb 4, 2026
5f150d4
Explain why in the standard description
rodrigoprimo Feb 6, 2026
019e0bb
Apply suggestions from code review
rodrigoprimo Feb 23, 2026
66adeda
Improve description and code samples based on PR review discussion
rodrigoprimo Feb 24, 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
29 changes: 29 additions & 0 deletions WordPress/Docs/PHP/NoSilencedErrorsStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="No Silenced Errors"
>
<standard>
<![CDATA[
The error silencing operator (@) should not be used. In the vast majority of cases, there is no need for the error silencing operator if the parameters passed to a function are checked ahead of the call.

As an exception, the operator is allowed for certain functions where warnings cannot be prevented.
]]>
</standard>
<code_comparison>
<code title="Valid: Calling a function without error silencing.">
<![CDATA[
if ( isset( $replace_pairs[''] ) ) {
unset( $replace_pairs[''] );
}

$result = <em></em>strtr( $str, $replace_pairs );
]]>
</code>
<code title="Invalid: Using the @ operator to silence warnings.">
<![CDATA[
$result = <em>@</em>strtr( $str, $replace_pairs );
]]>
</code>
</code_comparison>
</documentation>
Loading