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 1 commit
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
38 changes: 38 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,38 @@
<?xml version="1.0"?>
<documentation title="Type Casts">
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<documentation title="Type Casts">
<?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"
>

Copy link
Author

Choose a reason for hiding this comment

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

Added the schema header and xsi:noNamespaceSchemaLocation pointing to phpcsdocs.xsd.

<standard>
<![CDATA[
This sniff normalizes float type cast keywords.
Copy link
Member

Choose a reason for hiding this comment

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

This sentence seems redundant.

Copy link
Author

Choose a reason for hiding this comment

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

Reworded the opener to be shorter and clearer. It now states the rules enforced without repeating itself.


Use (float) instead of legacy synonyms:
- Disallowed: (double), (real)
- Allowed: (float)
Copy link
Member

Choose a reason for hiding this comment

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

This is incorrect/incomplete.

The sniff:

  • Forbids the use of non-standard casts for floats.
  • Forbids the use of the (unset) cast.
  • Discourages the use of the (binary) cast.

Considering the above, I believe the code samples also need work.

Copy link
Author

Choose a reason for hiding this comment

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

Updated the standard text and the code examples to cover all three behaviors:
• (double)/(real) → error (normalize to (float))
• (unset) → error (removed in PHP 8.0; suggest unset())
• (binary) → warning (discouraged)


Note: Other type-cast rules in the WordPress standard
are enforced by different sniffs:
- Short forms like (int), (bool), (string):
PSR12.Keywords.ShortFormTypeKeywords
- No spaces inside parentheses:
Squiz.WhiteSpace.CastSpacing
- Exactly one space after the cast:
Generic.Formatting.SpaceAfterCast
Copy link
Member

Choose a reason for hiding this comment

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

This whole block doesn't belong here. Each sniff functions independently of other sniffs. That also means that the docs should be independent of each other and should just focus on what this sniff does.

Copy link
Author

Choose a reason for hiding this comment

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

Thanks! I’ve removed the paragraph referencing other sniffs. The docs now only describe what WordPress.PHP.TypeCasts enforces.

]]>
</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="Invalid: legacy float casts">
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<code title="Invalid: legacy float casts">
<code title="Invalid: Using legacy float casts.">

Copy link
Author

Choose a reason for hiding this comment

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

Adjusted the code block titles to your suggested wording.

<![CDATA[
<?php
Copy link
Member

Choose a reason for hiding this comment

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

PHP open tag is not needed here. (Same for the "invalid" 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.

Removed <?php from all code samples as suggested.

$price = <em>(double)</em> $value;
$size = <em>(real)</em> $value;
]]>
</code>
<code title="Valid: normalized float cast">
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<code title="Valid: normalized float cast">
<code title="Valid: Using normalized float casts.">

Copy link
Author

Choose a reason for hiding this comment

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

Adjusted the code block titles to your suggested wording.

Copy link
Author

Choose a reason for hiding this comment

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

Updated code block titles to “Valid: Using normalized float casts.” (and similar phrasing for the other examples), as suggested.

<![CDATA[
<?php
$price = <em>(float)</em> $value;
$size = <em>(float)</em> $value;
]]>
</code>
</code_comparison>
</documentation>
Loading