Changeset 50936

Timestamp:

05/20/2021 12:03:04 AM (4 years ago)

Author:

SergeyBiryukov

Message:

General: Ensure consistent type for integer properties of a bookmark object.

Previously, these properties could be unexpectedly converted to strings in some contexts.

This applies to the following function:

• sanitize_bookmark_field()

and the following properties:

• $bookmark::link_id
• $bookmark::link_rating

Follow-up to [50935].

See #53235.

Location:

trunk

Files:

• src/wp-includes/bookmark.php (modified) (2 diffs)
• tests/phpunit/tests/bookmark/getBookmark.php (modified) (1 diff)

trunk/src/wp-includes/bookmark.php

@@ -392 +392 @@
  * @param mixed  $value       The bookmark field value.
  * @param int    $bookmark_id Bookmark ID.
- * @param string $context     How to filter the field value. Accepts 'raw', 'edit', 'attribute',
- *                            'js', 'db', or 'display'
+ * @param string $context     How to filter the field value. Accepts 'raw', 'edit', 'db',
+ *                            'display', 'attribute', or 'js'. Default 'display'.
  * @return mixed The filtered value.
  */
 function sanitize_bookmark_field( $field, $value, $bookmark_id, $context ) {
+    $int_fields = array( 'link_id', 'link_rating' );
+    if ( in_array( $field, $int_fields, true ) ) {
+        $value = (int) $value;
+    }
+
     switch ( $field ) {
-        case 'link_id': // ints
-        case 'link_rating':
-            $value = (int) $value;
-            break;
         case 'link_category': // array( ints )
             $value = array_map( 'absint', (array) $value );
@@ -446 +447 @@
     }
 
+    // Restore the type for integer fields after esc_attr().
+    if ( in_array( $field, $int_fields, true ) ) {
+        $value = (int) $value;
+    }
+
     return $value;
 }

trunk/tests/phpunit/tests/bookmark/getBookmark.php

@@ -342 +342 @@
 
     /**
+     * @ticket 53235
+     */
+    public function test_numeric_properties_should_be_cast_to_ints() {
+        $contexts = array( 'raw', 'edit', 'db', 'display', 'attribute', 'js' );
+
+        foreach ( $contexts as $context ) {
+            $bookmark = get_bookmark( self::$bookmark->link_id, OBJECT, $context );
+
+            $this->assertInternalType( 'int', $bookmark->link_id );
+            $this->assertInternalType( 'int', $bookmark->link_rating );
+        }
+    }
+
+    /**
      * Initialize the get_bookmark's function arguments to match the order of the function's signature and
      * reduce code in the tests.