<!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>[59118] trunk: Media: Add short-circuit filter to `attachment_url_to_postid()`.</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/59118">59118</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/59118","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-30 03:17:31 +0000 (Mon, 30 Sep 2024)</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'>Media: Add short-circuit filter to `attachment_url_to_postid()`.
Introduces the filter `pre_attachment_url_to_postid` to allow developers to short-circuit the function `attachment_url_to_postid()`.
The return values are expected to be an attachment ID, zero (`0`) to indicate no attachment was found or `null` to indicate the function should proceed as usual.
The function performs an expensive database query so developers making use of the function frequently may wish to use a custom table with appropriate indexes to reduce the load on their database server.
Props antpb, apermo, audrasjb, joedolson.
Fixes <a href="https://core.trac.wordpress.org/ticket/61383">#61383</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunktestsphpunittestsmediaphp">trunk/tests/phpunit/tests/media.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2024-09-30 01:54:44 UTC (rev 59117)
+++ trunk/src/wp-includes/media.php 2024-09-30 03:17:31 UTC (rev 59118)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5383,6 +5383,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function attachment_url_to_postid( $url ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</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 attachment ID to allow short-circuit the function.
+ *
+ * Allows plugins to short-circuit attachment ID lookups. Plugins making
+ * use of this function should return:
+ *
+ * - 0 (integer) to indicate the attachment is not found,
+ * - attachment ID (integer) to indicate the attachment ID found,
+ * - null to indicate WordPress should proceed with the lookup.
+ *
+ * Warning: The post ID may be null or zero, both of which cast to a
+ * boolean false. For information about casting to booleans see the
+ * {@link https://www.php.net/manual/en/language.types.boolean.php PHP documentation}.
+ * Use the === operator for testing the post ID when developing filters using
+ * this hook.
+ *
+ * @param int|null $post_id The result of the post ID lookup. Null to indicate
+ * no lookup has been attempted. Default null.
+ * @param string $url The URL being looked up.
+ */
+ $post_id = apply_filters( 'pre_attachment_url_to_postid', null, $url );
+ if ( null !== $post_id ) {
+ return (int) $post_id;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $dir = wp_get_upload_dir();
</span><span class="cx" style="display: block; padding: 0 10px"> $path = $url;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsmediaphp"></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/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/media.php 2024-09-30 01:54:44 UTC (rev 59117)
+++ trunk/tests/phpunit/tests/media.php 2024-09-30 03:17:31 UTC (rev 59118)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1273,6 +1273,75 @@
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'upload_dir', array( $this, 'upload_dir' ) );
</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">+ /**
+ * Test short-circuiting the attachment_url_to_postid filter.
+ *
+ * @ticket 61383
+ */
+ public function test_attachment_url_to_postid_short_circuit_filter_prevents_db_queries() {
+ $image_path = '2014/11/' . self::IMG_NAME;
+ $attachment_id = self::factory()->attachment->create_object(
+ $image_path,
+ 0,
+ array(
+ 'post_mime_type' => 'image/jpeg',
+ 'post_type' => 'attachment',
+ )
+ );
+ $image_url = wp_get_attachment_url( $attachment_id );
+
+ add_filter(
+ 'pre_attachment_url_to_postid',
+ function () use ( $attachment_id ) {
+ return $attachment_id;
+ }
+ );
+
+ $queries_before = get_num_queries();
+ $this->assertSame( $attachment_id, attachment_url_to_postid( $image_url ), 'The filter should short-circuit the function' );
+ $queries_after = get_num_queries();
+ $this->assertSame( 0, $queries_after - $queries_before, 'No database queries should be made by a short-circuited function' );
+ }
+
+ /**
+ * Test short-circuiting the attachment_url_to_postid filter with a not found result.
+ *
+ * @ticket 61383
+ */
+ public function test_attachment_url_to_postid_short_circuit_filter_when_attachment_does_not_exist() {
+ add_filter( 'pre_attachment_url_to_postid', '__return_zero' );
+
+ $queries_before = get_num_queries();
+ $this->assertSame( 0, attachment_url_to_postid( 'http://example.org/wp-content/uploads/2014/11/image.jpg' ), 'The filter should short-circuit the function' );
+ $queries_after = get_num_queries();
+ $this->assertSame( 0, $queries_after - $queries_before, 'No database queries should be made by a short-circuited function' );
+ }
+
+ /**
+ * Test short-circuiting the attachment_url_to_postid filter with a proceed result.
+ *
+ * @ticket 61383
+ */
+ public function test_attachment_url_to_postid_short_circuit_filter_should_proceed_if_filter_returns_null() {
+ $image_path = '2014/11/' . self::IMG_NAME;
+ $attachment_id = self::factory()->attachment->create_object(
+ $image_path,
+ 0,
+ array(
+ 'post_mime_type' => 'image/jpeg',
+ 'post_type' => 'attachment',
+ )
+ );
+ $image_url = wp_get_attachment_url( $attachment_id );
+
+ add_filter( 'pre_attachment_url_to_postid', '__return_null' );
+
+ $queries_before = get_num_queries();
+ $this->assertSame( $attachment_id, attachment_url_to_postid( $image_url ), 'The filter should return the attachment ID' );
+ $queries_after = get_num_queries();
+ $this->assertGreaterThan( 0, $queries_after - $queries_before, 'Database queries are expected when the filter returns null' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function upload_dir( $dir ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $dir['baseurl'] = 'http://192.168.1.20.com/wp-content/uploads';
</span><span class="cx" style="display: block; padding: 0 10px"> return $dir;
</span></span></pre>
</div>
</div>
</body>
</html>