Skip to content

Docs: Add documentation for WordPress.PHP.TypeCasts #2591

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
Open

Docs: Add documentation for WordPress.PHP.TypeCasts #2591

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f38caf
Docs: document (double|real) → (float) normalization for WordPress.PH…
brentwilson-clariio Aug 26, 2025
795e5ff
Docs: refine TypeCasts docs per review (double/real→float, forbid (un…
brentwilson-clariio Aug 26, 2025
6bf9ab7
Docs: reorder TypeCasts code examples to Valid (left) / Invalid (righ…
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
56 changes: 56 additions & 0 deletions WordPress/Docs/PHP/TypeCastsStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Type Casts"
>
<standard>
<![CDATA[
Enforce normalized and safe type casts.

• Use (float) instead of legacy float casts.
• Do not use the (unset) cast. Use unset().
• Avoid the (binary) cast (discouraged).
]]>
</standard>

<code_comparison>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code comparison should have "valid" on the left (first code sample), "invalid" on the right (second code sample).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback! I’ve reordered the code examples so that Valid is on the left and Invalid is on the right, as suggested.

<code title="Valid: Using normalized float casts.">
<![CDATA[
$price = <em>(float)</em> $value;
$size = <em>(float)</em> $value;
]]>
</code>
<code title="Invalid: Using legacy float casts.">
<![CDATA[
$price = <em>(double)</em> $value;
$size = <em>(real)</em> $value;
]]>
</code>
</code_comparison>

<code_comparison>
<code title="Valid: Use unset().">
<![CDATA[
unset( $value );
]]>
</code>
<code title="Invalid: Using the (unset) cast.">
<![CDATA[
result = <em>(unset)</em> $value;
]]>
</code>
</code_comparison>

<code_comparison>
<code title="Valid: Prefer a clear alternative.">
<![CDATA[
bytes = (string) $value;
]]>
</code>
<code title="Invalid: Using the (binary) cast.">
<![CDATA[
bytes = <em>(binary)</em> $value;
]]>
</code>
</code_comparison>
</documentation>
Loading