<!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>[49845] trunk/src: Upload: Introduce the `{$action}_overrides` filter that allows the overrides parameter for file uploads and file sideloads to be filtered.</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/49845">49845</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/49845","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>2020-12-20 16:13:23 +0000 (Sun, 20 Dec 2020)</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'>Upload: Introduce the `{$action}_overrides` filter that allows the overrides parameter for file uploads and file sideloads to be filtered.
The dynamic portion of the hook name, `$action`, refers to the post action.
Props iandunn, jakub.tyrcha, nacin, wonderboymusic, Mte90, johnbillion
Fixes <a href="https://core.trac.wordpress.org/ticket/16849">#16849</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
<li><a href="#trunksrcwpadminincludesmediaphp">trunk/src/wp-admin/includes/media.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesfilephp"></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/file.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php 2020-12-20 15:07:23 UTC (rev 49844)
+++ trunk/src/wp-admin/includes/file.php 2020-12-20 16:13:23 UTC (rev 49845)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -725,8 +725,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $file Reference to a single element of `$_FILES`.
</span><span class="cx" style="display: block; padding: 0 10px"> * Call the function once for each uploaded file.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string[]|false $overrides An associative array of names => values
- * to override default variables. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array|false $overrides {
+ * An array of override parameters for this file, or boolean false if none are provided.
+ *
+ * @type callable $upload_error_handler Function to call when there is an error during the upload process.
+ * @see wp_handle_upload_error().
+ * @type callable $unique_filename_callback Function to call when determining a unique file name for the file.
+ * @see wp_unique_filename().
+ * @type string[] $upload_error_strings The strings that describe the error indicated in
+ * `$_FILES[{form field}]['error']`.
+ * @type bool $test_form Whether to test that the `$_POST['action]` parameter is as expected.
+ * @type bool $test_size Whether to test that the file size is greater than zero bytes.
+ * @type bool $test_type Whether to test that the mime type of the file is as expected.
+ * @type string[] $mimes Array of allowed mime types keyed by their file extension regex.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $time Time formatted in 'yyyy/mm'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $action Expected value for `$_POST['action']`.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string[] On success, returns an associative array of file attributes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -745,14 +757,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the data for a file before it is uploaded to WordPress.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The dynamic portion of the hook name, `$action`, refers to the post action.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible filter names include:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - `wp_handle_sideload_prefilter`
+ * - `wp_handle_upload_prefilter`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0 as 'wp_handle_upload_prefilter'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.0.0 Converted to a dynamic hook with `$action`.
</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 string[] $file An array of data for a single file.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string[] $file An array of data for the file. Reference to a single element of `$_FILES`.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $file = apply_filters( "{$action}_prefilter", $file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the override parameters for a file before it is uploaded to WordPress.
+ *
+ * The dynamic portion of the hook name, `$action`, refers to the post action.
+ * Possible filter names include:
+ *
+ * - `wp_handle_sideload_overrides`
+ * - `wp_handle_upload_overrides`
+ *
+ * @since 5.7.0
+ *
+ * @param array|false $overrides An array of override parameters for this file. Boolean false if none are
+ * provided. @see _wp_handle_upload().
+ * @param string[] $file An array of data for the file. Reference to a single element of `$_FILES`.
+ */
+ $overrides = apply_filters( "{$action}_overrides", $overrides, $file );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // You may define your own function and pass the name in $overrides['upload_error_handler'].
</span><span class="cx" style="display: block; padding: 0 10px"> $upload_error_handler = 'wp_handle_upload_error';
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $overrides['upload_error_handler'] ) ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesmediaphp"></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/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/media.php 2020-12-20 15:07:23 UTC (rev 49844)
+++ trunk/src/wp-admin/includes/media.php 2020-12-20 16:13:23 UTC (rev 49845)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -430,7 +430,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0 The `$post_id` parameter was made optional.
</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 $file_array Array similar to a `$_FILES` upload array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $file_array Array that represents a `$_FILES` upload array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id Optional. The post ID the media is associated with.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $desc Optional. Description of the side-loaded file. Default null.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $post_data Optional. Post data to override. Default empty array.
</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 2020-12-20 15:07:23 UTC (rev 49844)
+++ trunk/src/wp-includes/functions.php 2020-12-20 16:13:23 UTC (rev 49845)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2791,7 +2791,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.4
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $filename File name or path.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string[] $mimes Optional. Array of mime types keyed by their file extension regex.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string[] $mimes Optional. Array of allowed mime types keyed by their file extension regex.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * Values for the extension and mime type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2833,7 +2833,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $file Full path to the file.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $filename The name of the file (may differ from $file due to $file being
</span><span class="cx" style="display: block; padding: 0 10px"> * in a tmp directory).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string[] $mimes Optional. Array of mime types keyed by their file extension regex.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string[] $mimes Optional. Array of allowed mime types keyed by their file extension regex.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array {
</span><span class="cx" style="display: block; padding: 0 10px"> * Values for the extension, mime type, and corrected filename.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>