Changeset 52955

Timestamp:

03/18/2022 08:46:17 PM (2 years ago)

Author:

johnbillion

Message:

Formatting: Add support for formatting sizes as PB, EB, ZB, and YB.

Props henry.wright, Presskopp

Fixes #40875

Location:

trunk

Files:

• src/wp-includes/default-constants.php (modified) (2 diffs)
• src/wp-includes/functions.php (modified) (3 diffs)
• tests/phpunit/tests/functions/sizeFormat.php (modified) (4 diffs)

trunk/src/wp-includes/default-constants.php

@@ -23 +23 @@
      *
      * @since 4.4.0
+     * @since 6.0.0 `PB_IN_BYTES`, `EB_IN_BYTES`, `ZB_IN_BYTES`, and `YB_IN_BYTES` were added.
      */
     define( 'KB_IN_BYTES', 1024 );
@@ -28 +29 @@
     define( 'GB_IN_BYTES', 1024 * MB_IN_BYTES );
     define( 'TB_IN_BYTES', 1024 * GB_IN_BYTES );
+    define( 'PB_IN_BYTES', 1024 * TB_IN_BYTES );
+    define( 'EB_IN_BYTES', 1024 * PB_IN_BYTES );
+    define( 'ZB_IN_BYTES', 1024 * EB_IN_BYTES );
+    define( 'YB_IN_BYTES', 1024 * ZB_IN_BYTES );
     /**#@-*/
 

trunk/src/wp-includes/functions.php

@@ -442 +442 @@
 
 /**
- * Convert number of bytes largest unit bytes will fit into.
+ * Converts a number of bytes to the largest unit the bytes will fit into.
  *
  * It is easier to read 1 KB than 1024 bytes and 1 MB than 1048576 bytes. Converts
  * number of bytes to human readable number by taking the number of that unit
- * that the bytes will go into it. Supports TB value.
+ * that the bytes will go into it. Supports YB value.
  *
  * Please note that integers in PHP are limited to 32 bits, unless they are on
@@ -456 +456 @@
  *
  * @since 2.3.0
+ * @since 6.0.0 Support for PB, EB, ZB, and YB was added.
  *
  * @param int|string $bytes    Number of bytes. Note max integer size for integers.
@@ -463 +464 @@
 function size_format( $bytes, $decimals = 0 ) {
     $quant = array(
+        /* translators: Unit symbol for yottabyte. */
+        _x( 'YB', 'unit symbol' ) => YB_IN_BYTES,
+        /* translators: Unit symbol for zettabyte. */
+        _x( 'ZB', 'unit symbol' ) => ZB_IN_BYTES,
+        /* translators: Unit symbol for exabyte. */
+        _x( 'EB', 'unit symbol' ) => EB_IN_BYTES,
+        /* translators: Unit symbol for petabyte. */
+        _x( 'PB', 'unit symbol' ) => PB_IN_BYTES,
         /* translators: Unit symbol for terabyte. */
         _x( 'TB', 'unit symbol' ) => TB_IN_BYTES,

trunk/tests/phpunit/tests/functions/sizeFormat.php

@@ -4 +4 @@
  * Tests for size_format()
  *
+ * @ticket 22405
  * @ticket 36635
+ * @ticket 40875
  *
  * @group functions.php
@@ -13 +15 @@
     public function _data_size_format() {
         return array(
+            // Invalid values
             array( array(), 0, false ),
             array( 'baba', 0, false ),
@@ -18 +21 @@
             array( '-1', 0, false ),
             array( -1, 0, false ),
+            // Bytes
             array( 0, 0, '0 B' ),
             array( 1, 0, '1 B' ),
             array( 1023, 0, '1,023 B' ),
+            // Kilobytes
             array( KB_IN_BYTES, 0, '1 KB' ),
             array( KB_IN_BYTES, 2, '1.00 KB' ),
@@ -26 +31 @@
             array( 2.5 * KB_IN_BYTES, 2, '2.50 KB' ),
             array( 10 * KB_IN_BYTES, 0, '10 KB' ),
+            // Megabytes
             array( (string) 1024 * KB_IN_BYTES, 2, '1.00 MB' ),
             array( MB_IN_BYTES, 0, '1 MB' ),
             array( 2.5 * MB_IN_BYTES, 0, '3 MB' ),
             array( 2.5 * MB_IN_BYTES, 2, '2.50 MB' ),
+            // Gigabytes
             array( (string) 1024 * MB_IN_BYTES, 2, '1.00 GB' ),
             array( GB_IN_BYTES, 0, '1 GB' ),
             array( 2.5 * GB_IN_BYTES, 0, '3 GB' ),
             array( 2.5 * GB_IN_BYTES, 2, '2.50 GB' ),
+            // Terabytes
             array( (string) 1024 * GB_IN_BYTES, 2, '1.00 TB' ),
             array( TB_IN_BYTES, 0, '1 TB' ),
             array( 2.5 * TB_IN_BYTES, 0, '3 TB' ),
             array( 2.5 * TB_IN_BYTES, 2, '2.50 TB' ),
+            // Petabytes
+            array( (string) 1024 * TB_IN_BYTES, 2, '1.00 PB' ),
+            array( PB_IN_BYTES, 0, '1 PB' ),
+            array( 2.5 * PB_IN_BYTES, 0, '3 PB' ),
+            array( 2.5 * PB_IN_BYTES, 2, '2.50 PB' ),
+            // Exabytes
+            array( (string) 1024 * PB_IN_BYTES, 2, '1.00 EB' ),
+            array( EB_IN_BYTES, 0, '1 EB' ),
+            array( 2.5 * EB_IN_BYTES, 0, '3 EB' ),
+            array( 2.5 * EB_IN_BYTES, 2, '2.50 EB' ),
+            // Zettabytes
+            array( (string) 1024 * EB_IN_BYTES, 2, '1.00 ZB' ),
+            array( ZB_IN_BYTES, 0, '1 ZB' ),
+            array( 2.5 * ZB_IN_BYTES, 0, '3 ZB' ),
+            array( 2.5 * ZB_IN_BYTES, 2, '2.50 ZB' ),
+            // Yottabytes
+            array( (string) 1024 * ZB_IN_BYTES, 2, '1.00 YB' ),
+            array( YB_IN_BYTES, 0, '1 YB' ),
+            array( 2.5 * YB_IN_BYTES, 0, '3 YB' ),
+            array( 2.5 * YB_IN_BYTES, 2, '2.50 YB' ),
+            // Edge values
             array( TB_IN_BYTES + ( TB_IN_BYTES / 2 ) + MB_IN_BYTES, 1, '1.5 TB' ),
             array( TB_IN_BYTES - MB_IN_BYTES - KB_IN_BYTES, 3, '1,023.999 GB' ),