Skip to content

PHP/TypeCasts: add XML documentation #2738

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
rodrigoprimo wants to merge 3 commits into
base: develop
Choose a base branch
from
+60 −0
Open

PHP/TypeCasts: add XML documentation #2738

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b24a63f
Docs: add documentation for WordPress.PHP.TypeCasts
brentwilson-clariio Aug 26, 2025
31462c7
Improve documentation for `WordPress.PHP.TypeCasts`
rodrigoprimo Jun 4, 2026
5e8b483
Apply suggestion from PR review
rodrigoprimo Jun 23, 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
60 changes: 60 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,60 @@
<?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[
The float cast must be used instead of the double and real casts. The real cast was deprecated in PHP 7.4 and removed in PHP 8.0. The double cast was deprecated in PHP 8.5.
]]>
</standard>
<code_comparison>
<code title="Valid: Using the normalized float cast.">
<![CDATA[
$price = <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>
<standard>
<![CDATA[
The unset cast must not be used. It was deprecated in PHP 7.2 and removed in PHP 8.0. Use unset() to unset a variable instead.
]]>
</standard>
<code_comparison>
<code title="Valid: Using the unset() language construct.">
<![CDATA[
<em>unset</em>( $value );
]]>
</code>
<code title="Invalid: Using the unset cast.">
<![CDATA[
$result = <em>(unset)</em> $value;
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
Using the binary cast or the b prefix is discouraged. The binary cast was deprecated in PHP 8.5. Use the string cast or a regular string literal instead.
]]>
</standard>
<code_comparison>
<code title="Valid: Using the string cast and a string literal.">
<![CDATA[
$bytes = <em>(string)</em> $value;
$text = <em>'hello'</em>;
]]>
</code>
<code title="Invalid: Using the binary cast and the b prefix.">
<![CDATA[
$bytes = <em>(binary)</em> $value;
$text = <em>b</em>'hello';
]]>
</code>
</code_comparison>
</documentation>
Loading