<!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>[44908] trunk/src/wp-admin/includes/ajax-actions.php: Privacy: Improve data export/erasure error messages and translator comments.</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/44908">44908</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/44908","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-03-15 18:06:08 +0000 (Fri, 15 Mar 2019)</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'>Privacy: Improve data export/erasure error messages and translator comments.
These changes address inaccuracies in current messages and makes them more informative.
Props birgire, garrett-eclipse, desrosj.
See <a href="https://core.trac.wordpress.org/ticket/43438">#43438</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesajaxactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php 2019-03-15 16:41:53 UTC (rev 44907)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2019-03-15 18:06:08 UTC (rev 44908)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4515,7 +4515,7 @@
</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"> if ( $exporter_index > count( $exporters ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_send_json_error( __( 'Exporter index out of range.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_send_json_error( __( 'Exporter index is out of range.' ) );
</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"> if ( $page < 1 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4528,33 +4528,35 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $exporter ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: %s: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: %s: exporter array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> sprintf( __( 'Expected an array describing the exporter at index %s.' ), $exporter_key )
</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"> if ( ! array_key_exists( 'exporter_friendly_name', $exporter ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: %s: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: %s: exporter array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> sprintf( __( 'Exporter array at index %s does not include a friendly name.' ), $exporter_key )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $exporter_friendly_name = $exporter['exporter_friendly_name'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( 'callback', $exporter ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: exporter friendly name */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- sprintf( __( 'Exporter does not include a callback: %s.' ), esc_html( $exporter['exporter_friendly_name'] ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sprintf( __( 'Exporter does not include a callback: %s.' ), esc_html( $exporter_friendly_name ) )
</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"> if ( ! is_callable( $exporter['callback'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: exporter friendly name */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- sprintf( __( 'Exporter callback is not a valid callback: %s.' ), esc_html( $exporter['exporter_friendly_name'] ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sprintf( __( 'Exporter callback is not a valid callback: %s.' ), esc_html( $exporter_friendly_name ) )
</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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $callback = $exporter['callback'];
- $exporter_friendly_name = $exporter['exporter_friendly_name'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $callback = $exporter['callback'];
+ $response = call_user_func( $callback, $email_address, $page );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = call_user_func( $callback, $email_address, $page );
</del><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error( $response );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4645,7 +4647,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = wp_get_user_request_data( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $request || 'remove_personal_data' !== $request->action_name ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_send_json_error( __( 'Invalid request ID.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_send_json_error( __( 'Invalid request type.' ) );
</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"> $email_address = $request->email;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4708,28 +4710,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $eraser = $erasers[ $eraser_key ];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $eraser ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: %d: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: %d: eraser array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error( sprintf( __( 'Expected an array describing the eraser at index %d.' ), $eraser_index ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! array_key_exists( 'eraser_friendly_name', $eraser ) ) {
+ /* translators: %d: eraser array index */
+ wp_send_json_error( sprintf( __( 'Eraser array at index %d does not include a friendly name.' ), $eraser_index ) );
+ }
+
+ $eraser_friendly_name = $eraser['eraser_friendly_name'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( 'callback', $eraser ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: %d: array index */
- wp_send_json_error( sprintf( __( 'Eraser array at index %d does not include a callback.' ), $eraser_index ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_send_json_error(
+ sprintf(
+ /* translators: %s: eraser friendly name */
+ __( 'Eraser does not include a callback: %s.' ),
+ esc_html( $eraser_friendly_name )
+ )
+ );
</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"> if ( ! is_callable( $eraser['callback'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: %d: array index */
- wp_send_json_error( sprintf( __( 'Eraser callback at index %d is not a valid callback.' ), $eraser_index ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_send_json_error(
+ sprintf(
+ /* translators: %s: eraser friendly name */
+ __( 'Eraser callback is not valid: %s.' ),
+ esc_html( $eraser_friendly_name )
+ )
+ );
</ins><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">- if ( ! array_key_exists( 'eraser_friendly_name', $eraser ) ) {
- /* translators: %d: array index */
- wp_send_json_error( sprintf( __( 'Eraser array at index %d does not include a friendly name.' ), $eraser_index ) );
- }
-
- $callback = $eraser['callback'];
- $eraser_friendly_name = $eraser['eraser_friendly_name'];
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $callback = $eraser['callback'];
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = call_user_func( $callback, $email_address, $page );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4739,7 +4751,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: eraser friendly name, 2: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: 1: eraser friendly name, 2: eraser array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> __( 'Did not receive array from %1$s eraser (index %2$d).' ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $eraser_friendly_name ),
</span><span class="cx" style="display: block; padding: 0 10px"> $eraser_index
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4750,7 +4762,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( 'items_removed', $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: eraser friendly name, 2: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: 1: eraser friendly name, 2: eraser array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> __( 'Expected items_removed key in response array from %1$s eraser (index %2$d).' ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $eraser_friendly_name ),
</span><span class="cx" style="display: block; padding: 0 10px"> $eraser_index
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4761,7 +4773,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( 'items_retained', $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: eraser friendly name, 2: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: 1: eraser friendly name, 2: eraser array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> __( 'Expected items_retained key in response array from %1$s eraser (index %2$d).' ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $eraser_friendly_name ),
</span><span class="cx" style="display: block; padding: 0 10px"> $eraser_index
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4772,7 +4784,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( 'messages', $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: eraser friendly name, 2: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: 1: eraser friendly name, 2: eraser array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> __( 'Expected messages key in response array from %1$s eraser (index %2$d).' ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $eraser_friendly_name ),
</span><span class="cx" style="display: block; padding: 0 10px"> $eraser_index
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4783,7 +4795,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $response['messages'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: eraser friendly name, 2: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: 1: eraser friendly name, 2: eraser array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> __( 'Expected messages key to reference an array in response array from %1$s eraser (index %2$d).' ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $eraser_friendly_name ),
</span><span class="cx" style="display: block; padding: 0 10px"> $eraser_index
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4794,7 +4806,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( 'done', $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_error(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: 1: eraser friendly name, 2: array index */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /* translators: 1: eraser friendly name, 2: eraser array index */
</ins><span class="cx" style="display: block; padding: 0 10px"> __( 'Expected done flag in response array from %1$s eraser (index %2$d).' ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $eraser_friendly_name ),
</span><span class="cx" style="display: block; padding: 0 10px"> $eraser_index
</span></span></pre>
</div>
</div>
</body>
</html>