Changeset 44407

Timestamp:

01/06/2019 08:07:34 PM (4 years ago)

Author:

desrosj

Message:

General: Introduce wp_unique_id(), a PHP implementation of Underscore's uniqueId method.

A static variable contains an integer that is incremented with each call. This number is returned with the optional prefix.
As such the returned value is not universally unique, but it is unique across the life of the PHP process.

Props westonruter, dlh.

Merges [43658] and [44406] to the 5.0 branch.
See #44883.

Location:

branches/5.0

Files:

• . (modified) (1 prop)
• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/tests/functions.php (modified) (1 diff)

branches/5.0/src/wp-includes/functions.php

@@ -5795 +5795 @@
 
 /**
+ * Get unique ID.
+ *
+ * This is a PHP implementation of Underscore's uniqueId method. A static variable
+ * contains an integer that is incremented with each call. This number is returned
+ * with the optional prefix. As such the returned value is not universally unique,
+ * but it is unique across the life of the PHP process.
+ *
+ * @since 5.0.3
+ *
+ * @staticvar int $id_counter
+ *
+ * @param string $prefix Prefix for the returned ID.
+ * @return string Unique ID.
+ */
+function wp_unique_id( $prefix = '' ) {
+    static $id_counter = 0;
+    return $prefix . (string) ++$id_counter;
+}
+
+/**
  * Get last changed date for the specified cache group.
  *

branches/5.0/tests/phpunit/tests/functions.php

@@ -961 +961 @@
 
     /**
+     * Tests wp_unique_id().
+     *
+     * @covers ::wp_unique_id
+     * @ticket 44883
+     */
+    function test_wp_unique_id() {
+
+        // Test without prefix.
+        $ids = array();
+        for ( $i = 0; $i < 20; $i += 1 ) {
+            $id = wp_unique_id();
+            $this->assertInternalType( 'string', $id );
+            $this->assertTrue( is_numeric( $id ) );
+            $ids[] = $id;
+        }
+        $this->assertEquals( $ids, array_unique( $ids ) );
+
+        // Test with prefix.
+        $ids = array();
+        for ( $i = 0; $i < 20; $i += 1 ) {
+            $id = wp_unique_id( 'foo-' );
+            $this->assertRegExp( '/^foo-\d+$/', $id );
+            $ids[] = $id;
+        }
+        $this->assertEquals( $ids, array_unique( $ids ) );
+    }
+
+    /**
      * @ticket 40017
      * @dataProvider _wp_get_image_mime