<!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>[42186] branches/4.9: Widgets: Set global `$post` to current queried object instead of nullifying when `is_singular()` while applying filters (and shortcodes) in Text widget and (via plugin) Custom HTML widget.</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 { 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/42186">42186</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/42186","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-11-15 02:32:06 +0000 (Wed, 15 Nov 2017)</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'>Widgets: Set global `$post` to current queried object instead of nullifying when `is_singular()` while applying filters (and shortcodes) in Text widget and (via plugin) Custom HTML widget.
Also prevent `[gallery]` shortcode from dumping out every attachment on the site when a containing Text widget is shown on an archive template.
Props westonruter, bobbingwide, joemcgill for testing.
See <a href="https://core.trac.wordpress.org/ticket/10457">#10457</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/42548">#42548</a>, <a href="https://core.trac.wordpress.org/ticket/42547">#42547</a> for 4.9.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches49srcwpincludeswidgetsclasswpwidgetcustomhtmlphp">branches/4.9/src/wp-includes/widgets/class-wp-widget-custom-html.php</a></li>
<li><a href="#branches49srcwpincludeswidgetsclasswpwidgettextphp">branches/4.9/src/wp-includes/widgets/class-wp-widget-text.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches49">branches/4.9/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.9
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.9 2017-11-15 02:26:56 UTC (rev 42185)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.9 2017-11-15 02:32:06 UTC (rev 42186)
</ins><a id="branches49"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.9</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches49srcwpincludeswidgetsclasswpwidgetcustomhtmlphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/widgets/class-wp-widget-custom-html.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/widgets/class-wp-widget-custom-html.php 2017-11-15 02:26:56 UTC (rev 42185)
+++ branches/4.9/src/wp-includes/widgets/class-wp-widget-custom-html.php 2017-11-15 02:32:06 UTC (rev 42186)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,16 +81,49 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter gallery shortcode attributes.
+ *
+ * Prevents all of a site's attachments from being shown in a gallery displayed on a
+ * non-singular template where a $post context is not available.
+ *
+ * @since 4.9.0
+ *
+ * @param array $attrs Attributes.
+ * @return array Attributes.
+ */
+ public function _filter_gallery_shortcode_attrs( $attrs ) {
+ if ( ! is_singular() && empty( $attrs['id'] ) && empty( $attrs['include'] ) ) {
+ $attrs['id'] = -1;
+ }
+ return $attrs;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Outputs the content for the current Custom HTML widget instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.8.1
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Post $post
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Display arguments including 'before_title', 'after_title',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'before_widget', and 'after_widget'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $instance Settings for the current Custom HTML widget instance.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function widget( $args, $instance ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $post;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Override global $post so filters (and shortcodes) apply in a consistent context.
+ $original_post = $post;
+ if ( is_singular() ) {
+ // Make sure post is always the queried object on singular queries (not from another sub-query that failed to clean up the global $post).
+ $post = get_queried_object();
+ } else {
+ // Nullify the $post global during widget rendering to prevent shortcodes from running with the unexpected context on archive queries.
+ $post = null;
+ }
+
+ // Prevent dumping out all attachments from the media library.
+ add_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $instance = array_merge( $this->default_instance, $instance );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,6 +151,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $content = apply_filters( 'widget_custom_html_content', $content, $instance, $this );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Restore post global.
+ $post = $original_post;
+ remove_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Inject the Text widget's container class name alongside this widget's class name for theme styling compatibility.
</span><span class="cx" style="display: block; padding: 0 10px"> $args['before_widget'] = preg_replace( '/(?<=\sclass=["\'])/', 'widget_text ', $args['before_widget'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="branches49srcwpincludeswidgetsclasswpwidgettextphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/widgets/class-wp-widget-text.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/widgets/class-wp-widget-text.php 2017-11-15 02:26:56 UTC (rev 42185)
+++ branches/4.9/src/wp-includes/widgets/class-wp-widget-text.php 2017-11-15 02:32:06 UTC (rev 42186)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -179,6 +179,24 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter gallery shortcode attributes.
+ *
+ * Prevents all of a site's attachments from being shown in a gallery displayed on a
+ * non-singular template where a $post context is not available.
+ *
+ * @since 4.9.0
+ *
+ * @param array $attrs Attributes.
+ * @return array Attributes.
+ */
+ public function _filter_gallery_shortcode_attrs( $attrs ) {
+ if ( ! is_singular() && empty( $attrs['id'] ) && empty( $attrs['include'] ) ) {
+ $attrs['id'] = -1;
+ }
+ return $attrs;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Outputs the content for the current Text widget instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -221,13 +239,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'widget_text', 'do_shortcode', $widget_text_do_shortcode_priority );
</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">- // Nullify the $post global during widget rendering to prevent shortcodes from running with the unexpected context.
- $suspended_post = null;
- if ( isset( $post ) ) {
- $suspended_post = $post;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Override global $post so filters (and shortcodes) apply in a consistent context.
+ $original_post = $post;
+ if ( is_singular() ) {
+ // Make sure post is always the queried object on singular queries (not from another sub-query that failed to clean up the global $post).
+ $post = get_queried_object();
+ } else {
+ // Nullify the $post global during widget rendering to prevent shortcodes from running with the unexpected context on archive queries.
</ins><span class="cx" style="display: block; padding: 0 10px"> $post = null;
</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">+ // Prevent dumping out all attachments from the media library.
+ add_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the content of the Text widget.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -278,9 +302,8 @@
</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"> // Restore post global.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $suspended_post ) ) {
- $post = $suspended_post;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post = $original_post;
+ remove_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Undo suspension of legacy plugin-supplied shortcode handling.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $should_suspend_legacy_shortcode_support ) {
</span></span></pre>
</div>
</div>
</body>
</html>