<!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>[56482] trunk/src: Privacy: Improve docblocks for hooks and functions related to personal data export and erasure.</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/56482">56482</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/56482","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>2023-08-28 21:51:44 +0000 (Mon, 28 Aug 2023)</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 docblocks for hooks and functions related to personal data export and erasure.
See <a href="https://core.trac.wordpress.org/ticket/58833">#58833</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.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 2023-08-28 17:12:46 UTC (rev 56481)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2023-08-28 21:51:44 UTC (rev 56482)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4939,8 +4939,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of personal data exporters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type callable $callback Callable exporter function that accepts an
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * email address and a page and returns an array
- * of name => value pairs of personal data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * email address and a page number and returns an
+ * array of name => value pairs of personal data.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $exporter_friendly_name Translated user facing friendly name for the
</span><span class="cx" style="display: block; padding: 0 10px"> * exporter.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5051,10 +5051,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $response The personal data for the given exporter and page.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $response The personal data for the given exporter and page number.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $exporter_index The index of the exporter that provided this data.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_address The email address associated with this personal data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $page The page for this response.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $page The page number for this response.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $request_id The privacy request post ID associated with this request.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $send_as_email Whether the final results of the export should be emailed to the user.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $exporter_key The key (slug) of the exporter that provided this data.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5128,8 +5128,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array ...$0 {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of personal data exporters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type callable $callback Callable eraser that accepts an email address and
- * a page and returns an array with boolean values for
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type callable $callback Callable eraser that accepts an email address and a page
+ * number, and returns an array with boolean values for
</ins><span class="cx" style="display: block; padding: 0 10px"> * whether items were removed or retained and any messages
</span><span class="cx" style="display: block; padding: 0 10px"> * from the eraser, as well as if additional pages are
</span><span class="cx" style="display: block; padding: 0 10px"> * available.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5281,10 +5281,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $response The personal data for the given exporter and page.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $response {
+ * The personal data for the given exporter and page number.
+ *
+ * @type bool $items_removed Whether items were actually removed or not.
+ * @type bool $items_retained Whether items were retained or not.
+ * @type string[] $messages An array of messages to add to the personal data export file.
+ * @type bool $done Whether the eraser is finished or not.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $eraser_index The index of the eraser that provided this data.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_address The email address associated with this personal data.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $page The page for this response.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $page The page number for this response.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $request_id The privacy request post ID associated with this request.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $eraser_key The key (slug) of the eraser that provided this data.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludescommentphp"></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/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2023-08-28 17:12:46 UTC (rev 56481)
+++ trunk/src/wp-includes/comment.php 2023-08-28 21:51:44 UTC (rev 56482)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3684,8 +3684,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $exporters An array of personal data exporters.
- * @return array An array of personal data exporters.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array[] $exporters An array of personal data exporters.
+ * @return array[] An array of personal data exporters.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_register_comment_personal_data_exporter( $exporters ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $exporters['wordpress-comments'] = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3702,8 +3702,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_address The comment author email address.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $page Comment page.
- * @return array An array of personal data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $page Comment page number.
+ * @return array {
+ * An array of personal data.
+ *
+ * @type array[] $data An array of personal data arrays.
+ * @type bool $done Whether the exporter is finished.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_comments_personal_data_exporter( $email_address, $page = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Limit us to 500 comments at a time to avoid timing out.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3814,8 +3819,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_address The comment author email address.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $page Comment page.
- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $page Comment page number.
+ * @return array {
+ * Data removal results.
+ *
+ * @type bool $items_removed Whether items were actually removed.
+ * @type bool $items_retained Whether items were retained.
+ * @type string[] $messages An array of messages to add to the personal data export file.
+ * @type bool $done Whether the eraser is finished.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_comments_personal_data_eraser( $email_address, $page = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span></span></pre></div>
<a id="trunksrcwpincludesmediaphp"></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/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php 2023-08-28 17:12:46 UTC (rev 56481)
+++ trunk/src/wp-includes/media.php 2023-08-28 21:51:44 UTC (rev 56482)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5359,8 +5359,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_address The attachment owner email address.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $page Attachment page.
- * @return array An array of personal data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $page Attachment page number.
+ * @return array {
+ * An array of personal data.
+ *
+ * @type array[] $data An array of personal data arrays.
+ * @type bool $done Whether the exporter is finished.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_media_personal_data_exporter( $email_address, $page = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Limit us to 50 attachments at a time to avoid timing out.
</span></span></pre></div>
<a id="trunksrcwpincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2023-08-28 17:12:46 UTC (rev 56481)
+++ trunk/src/wp-includes/user.php 2023-08-28 21:51:44 UTC (rev 56482)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3807,7 +3807,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.4.0 Added 'Session Tokens' group to the export data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_address The user's email address.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array An array of personal data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array {
+ * An array of personal data.
+ *
+ * @type array[] $data An array of personal data arrays.
+ * @type bool $done Whether the exporter is finished.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_user_personal_data_exporter( $email_address ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $email_address = trim( $email_address );
</span></span></pre>
</div>
</div>
</body>
</html>