Changeset 62717 for trunk/src/wp-includes/post.php

Timestamp:

07/14/2026 12:27:51 AM (7 weeks ago)

Author:

westonruter

Message:

Code Quality: Improve WP_Post type coverage.

Add a Data_Array array-shape type describing every key returned by WP_Post::to_array(), and tighten each WP_Post property to the narrowest type the schema and code guarantee:

• ID and post_parent become non-negative-int.
• comment_count becomes numeric-string, and post_author becomes numeric-string|'' (a user ID, or an empty string for a default post that has not yet been assigned an author).
• The always-populated post_status, comment_status, ping_status, and post_type slugs become non-empty-string, left open rather than enumerated so custom statuses and types remain valid.
• The magic ancestors, post_category, and tags_input accessors become precise lists (list<non-negative-int> and list<non-empty-string>).

The shape stays open because WP_Post permits dynamic properties. Fields that can legitimately be empty, including the datetime fields (which get_default_post_to_edit() may leave empty), stay string, and menu_order stays int since it can be negative.

Correct WP_Post::$filter, which was previously typed without null or the 'sample' context: an unsanitized post has no filter (checked in core via isset() and empty()), and get_sample_permalink() has assigned 'sample' since [8526]. Widen sanitize_post_field()'s $context to accept 'sample' to match, which it already treats as a 'display' context.

Also type get_post_ancestors() as returning list<non-negative-int>, read the post in trackback_url_list() via to_array() while guarding against a missing post, and cast post_author to a string in WP_Customize_Nav_Menu_Item_Setting and inject_ignored_hooked_blocks_metadata_attributes(), which each populate an object before passing it to new WP_Post().

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12491.
Follow-up to r62648, r62694.

See #64898, #64896.

File:

• trunk/src/wp-includes/post.php (modified) (6 diffs)

trunk/src/wp-includes/post.php

@@ -1186 +1186 @@
  * @param int|WP_Post $post Post ID or post object.
  * @return int[] Array of ancestor IDs or empty array if there are none.
+ * @phpstan-return list<non-negative-int>
  */
 function get_post_ancestors( $post ) {
@@ -3002 +3003 @@
  * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and
  * 'js'. The 'display' context is used by default. 'attribute' and 'js' contexts
- * are treated like 'display' when calling filters.
+ * are treated like 'display' when calling filters. The 'sample' value is used
+ * for permalink previewing.
  *
  * @since 2.3.0
@@ -3010 +3012 @@
  * @param mixed  $value   The Post Object value.
  * @param int    $post_id Post ID.
- * @param string $context Optional. How to sanitize the field. Possible values are 'raw', 'edit',
- *                        'db', 'display', 'attribute' and 'js'. Default 'display'.
+ * @param string $context Optional. How to sanitize the field. Possible values are 'raw', 'edit', 'db', 'display',
+ *                        'attribute' and 'js'. The 'sample' value is used for permalink previewing. Default 'display'.
  * @return mixed Sanitized value.
  *
- * @phpstan-param 'raw'|'edit'|'db'|'display'|'attribute'|'js' $context
+ * @phpstan-param 'raw'|'edit'|'db'|'display'|'attribute'|'js'|'sample' $context
  * @phpstan-return (
  *     $field is 'ID'|'post_parent'|'menu_order' ? int : (
@@ -3287 +3289 @@
                          * @param string $context Context for how to sanitize the field.
                          *                        Accepts 'raw', 'edit', 'db', 'display',
-                         *                        'attribute', or 'js'. Default 'display'.
+                         *                        'attribute', or 'js'. The 'sample' value is
+                         *                        used for permalink previewing. Default 'display'.
                          */
                         $value = apply_filters( "{$field}", $value, $post_id, $context );
@@ -3314 +3317 @@
                          * @param string $context Context for how to sanitize the field.
                          *                        Accepts 'raw', 'edit', 'db', 'display',
-                         *                        'attribute', or 'js'. Default 'display'.
+                         *                        'attribute', or 'js'. The 'sample' value is
+                         *                        used for permalink previewing. Default 'display'.
                          */
                         $value = apply_filters( "post_{$field}", $value, $post_id, $context );
@@ -6150 +6154 @@
         if ( ! empty( $tb_list ) ) {
                 // Get post data.
-                $postdata = get_post( $post_id, ARRAY_A );
-
-                if ( ! $postdata ) {
+                $post = get_post( $post_id );
+                if ( ! $post ) {
                         return;
                 }
+                $postdata = $post->to_array();
 
                 // Form an excerpt.