Changeset 55549

Timestamp:

03/14/2023 04:53:07 PM (19 months ago)

Author:

SergeyBiryukov

Message:

Docs: Fix typo in _validate_cache_id() description.

Includes:

• Capitalizing "ID" in a consistent way.
• Expanding the comment on not using filter_var().
• Adding a @covers tag for the function in unit tests.
• Minor tweak to the _doing_it_wrong() message.

Follow-up to [53818], [55543].

See #57593.

Location:

trunk

Files:

• src/wp-includes/class-wp-object-cache.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (2 diffs)
• tests/phpunit/tests/functions/getNonCachedIds.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-object-cache.php

@@ -157 +157 @@
             ? __( 'Cache key must not be an empty string.' )
             /* translators: %s: The type of the given cache key. */
-            : sprintf( __( 'Cache key must be integer or non-empty string, %s given.' ), $type );
+            : sprintf( __( 'Cache key must be an integer or a non-empty string, %s given.' ), $type );
 
         _doing_it_wrong(

trunk/src/wp-includes/functions.php

@@ -7035 +7035 @@
 
 /**
- * Checks whether the given cache ID is either an integer or iterger-like strings.
- * Both `16` and `"16"` are considered valid, other numeric types and numeric
- * strings (`16.3` and `"16.3"`) are considered invalid.
+ * Checks whether the given cache ID is either an integer or an integer-like string.
+ *
+ * Both `16` and `"16"` are considered valid, other numeric types and numeric strings
+ * (`16.3` and `"16.3"`) are considered invalid.
  *
  * @since 6.3.0
  *
- * @param mixed $object_id The cache id to validate.
- * @return bool Whether the given $object_id is a valid cache id.
+ * @param mixed $object_id The cache ID to validate.
+ * @return bool Whether the given $object_id is a valid cache ID.
  */
 function _validate_cache_id( $object_id ) {
-    // Unfortunately filter_var() is considered an optional extension
+    /*
+     * filter_var() could be used here, but the `filter` PHP extension
+     * is considered optional and may not be available.
+     */
     if ( is_int( $object_id )
         || ( is_string( $object_id ) && (string) (int) $object_id === $object_id ) ) {
@@ -7051 +7055 @@
     }
 
-    /* translators: %s: The type of the given object id. */
-    $message = sprintf( __( 'Object id must be integer, %s given.' ), gettype( $object_id ) );
+    /* translators: %s: The type of the given object ID. */
+    $message = sprintf( __( 'Object ID must be an integer, %s given.' ), gettype( $object_id ) );
     _doing_it_wrong( '_get_non_cached_ids', $message, '6.3.0' );
 

trunk/tests/phpunit/tests/functions/getNonCachedIds.php

@@ -8 +8 @@
  *
  * @covers ::_get_non_cached_ids
+ * @covers ::_validate_cache_id
  */
 class Tests_Functions_GetNonCachedIds extends WP_UnitTestCase {
@@ -29 +30 @@
      * @dataProvider data_valid_ids_should_be_returned_as_integers
      *
-     * @param mixed $object_id The object id.
+     * @param mixed $object_id The object ID.
      */
     public function test_valid_ids_should_be_returned_as_integers( $object_id ) {
@@ -70 +71 @@
      * @dataProvider data_invalid_cache_ids_should_throw_a_notice
      *
-     * @param mixed $object_id The object id.
+     * @param mixed $object_id The object ID.
      */
     public function test_invalid_cache_ids_should_throw_a_notice( $object_id ) {