<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[52955] trunk: Formatting: Add support for formatting sizes as PB, EB, ZB, and YB.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/52955">52955</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/52955","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-03-18 20:46:17 +0000 (Fri, 18 Mar 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Formatting: Add support for formatting sizes as PB, EB, ZB, and YB.
Props henry.wright, Presskopp
Fixes <a href="https://core.trac.wordpress.org/ticket/40875">#40875</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultconstantsphp">trunk/src/wp-includes/default-constants.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsfunctionssizeFormatphp">trunk/tests/phpunit/tests/functions/sizeFormat.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultconstantsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/default-constants.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-constants.php 2022-03-18 20:42:43 UTC (rev 52954)
+++ trunk/src/wp-includes/default-constants.php 2022-03-18 20:46:17 UTC (rev 52955)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,11 +22,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Constants for expressing human-readable data sizes in their respective number of bytes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.0.0 `PB_IN_BYTES`, `EB_IN_BYTES`, `ZB_IN_BYTES`, and `YB_IN_BYTES` were added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'KB_IN_BYTES', 1024 );
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'MB_IN_BYTES', 1024 * KB_IN_BYTES );
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'GB_IN_BYTES', 1024 * MB_IN_BYTES );
</span><span class="cx" style="display: block; padding: 0 10px"> define( 'TB_IN_BYTES', 1024 * GB_IN_BYTES );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> /**#@-*/
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Start of run timestamp.
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2022-03-18 20:42:43 UTC (rev 52954)
+++ trunk/src/wp-includes/functions.php 2022-03-18 20:46:17 UTC (rev 52955)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -441,11 +441,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Convert number of bytes largest unit bytes will fit into.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Converts a number of bytes to the largest unit the bytes will fit into.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * It is easier to read 1 KB than 1024 bytes and 1 MB than 1048576 bytes. Converts
</span><span class="cx" style="display: block; padding: 0 10px"> * number of bytes to human readable number by taking the number of that unit
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * that the bytes will go into it. Supports TB value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * that the bytes will go into it. Supports YB value.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Please note that integers in PHP are limited to 32 bits, unless they are on
</span><span class="cx" style="display: block; padding: 0 10px"> * 64 bit architecture, then they have 64 bit size. If you need to place the
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -455,6 +455,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Technically the correct unit names for powers of 1024 are KiB, MiB etc.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.0.0 Support for PB, EB, ZB, and YB was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $bytes Number of bytes. Note max integer size for integers.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $decimals Optional. Precision of number of decimal places. Default 0.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -462,6 +463,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function size_format( $bytes, $decimals = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $quant = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* 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,
</ins><span class="cx" style="display: block; padding: 0 10px"> /* translators: Unit symbol for terabyte. */
</span><span class="cx" style="display: block; padding: 0 10px"> _x( 'TB', 'unit symbol' ) => TB_IN_BYTES,
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: Unit symbol for gigabyte. */
</span></span></pre></div>
<a id="trunktestsphpunittestsfunctionssizeFormatphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/functions/sizeFormat.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions/sizeFormat.php 2022-03-18 20:42:43 UTC (rev 52954)
+++ trunk/tests/phpunit/tests/functions/sizeFormat.php 2022-03-18 20:46:17 UTC (rev 52955)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,7 +3,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Tests for size_format()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 22405
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 36635
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 40875
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @group functions.php
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::size_format
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,31 +14,58 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function _data_size_format() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Invalid values
</ins><span class="cx" style="display: block; padding: 0 10px"> array( array(), 0, false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'baba', 0, false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '', 0, false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '-1', 0, false ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( -1, 0, false ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bytes
</ins><span class="cx" style="display: block; padding: 0 10px"> array( 0, 0, '0 B' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 1, 0, '1 B' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 1023, 0, '1,023 B' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Kilobytes
</ins><span class="cx" style="display: block; padding: 0 10px"> array( KB_IN_BYTES, 0, '1 KB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( KB_IN_BYTES, 2, '1.00 KB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * KB_IN_BYTES, 0, '3 KB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * KB_IN_BYTES, 2, '2.50 KB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 10 * KB_IN_BYTES, 0, '10 KB' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Megabytes
</ins><span class="cx" style="display: block; padding: 0 10px"> array( (string) 1024 * KB_IN_BYTES, 2, '1.00 MB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( MB_IN_BYTES, 0, '1 MB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * MB_IN_BYTES, 0, '3 MB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * MB_IN_BYTES, 2, '2.50 MB' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Gigabytes
</ins><span class="cx" style="display: block; padding: 0 10px"> array( (string) 1024 * MB_IN_BYTES, 2, '1.00 GB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( GB_IN_BYTES, 0, '1 GB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * GB_IN_BYTES, 0, '3 GB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * GB_IN_BYTES, 2, '2.50 GB' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Terabytes
</ins><span class="cx" style="display: block; padding: 0 10px"> array( (string) 1024 * GB_IN_BYTES, 2, '1.00 TB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( TB_IN_BYTES, 0, '1 TB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * TB_IN_BYTES, 0, '3 TB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 2.5 * TB_IN_BYTES, 2, '2.50 TB' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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
</ins><span class="cx" style="display: block; padding: 0 10px"> array( TB_IN_BYTES + ( TB_IN_BYTES / 2 ) + MB_IN_BYTES, 1, '1.5 TB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( TB_IN_BYTES - MB_IN_BYTES - KB_IN_BYTES, 3, '1,023.999 GB' ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre>
</div>
</div>
</body>
</html>