Changeset 62640 for trunk/src/wp-includes/class-wp-comment.php

Timestamp:

07/06/2026 04:12:52 AM (3 months ago)

Author:

westonruter

Message:

Docs: Add numeric-string types to DB-backed class properties.

Add @phpstan-var numeric-string annotations to string properties which hold integer database values:

• WP_Comment::$comment_ID
• WP_Comment::$comment_post_ID
• WP_Comment::$comment_karma
• WP_Comment::$comment_parent
• WP_Comment::$user_id
• the eight WP_Site properties backed by integer columns of the wp_blogs table
• the private WP_Network::$blog_id property

Previously the numeric-string nature of such properties was only indicated in the property description:

A numeric string, for compatibility reasons.

Additionally, document the magic WP_Network::$blog_id property, which is exposed via __get() as a numeric string but was missing from the class-level @property tags.

Finally, correct the documented types of three magic properties:

• WP_Site::$post_count is lazy-loaded via get_option(), so it is a numeric string once read back from the database and false when the option is not set (new sites with no published posts); it holds an integer only when served from the options cache in the same request that updated it.
• WP_User::$user_status always holds a numeric string coming raw off the users table row.
• WP_User::$user_level resolves through user metadata as a numeric string (or an empty string when the metadata is absent), holding an integer only after WP_User::update_user_level_from_caps() has assigned one to the instance in the same request.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12408.
Follow-up to r37657, r37870, r38630, r48941, r62437.

See #44723, #64896, #64898.

File:

• trunk/src/wp-includes/class-wp-comment.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-comment.php

@@ -23 +23 @@
          * @since 4.4.0
          * @var string
+         * @phpstan-var numeric-string
          */
         public $comment_ID;
@@ -33 +34 @@
          * @since 4.4.0
          * @var string
+         * @phpstan-var numeric-string
          */
         public $comment_post_ID = '0';
@@ -99 +101 @@
          * @since 4.4.0
          * @var string
+         * @phpstan-var numeric-string
          */
         public $comment_karma = '0';
@@ -134 +137 @@
          * @since 4.4.0
          * @var string
+         * @phpstan-var numeric-string
          */
         public $comment_parent = '0';
@@ -144 +148 @@
          * @since 4.4.0
          * @var string
+         * @phpstan-var numeric-string
          */
         public $user_id = '0';