<!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>[48756] branches/5.5/src/wp-admin/includes: Docs: Correct usage of the dynamic auto_update_{$type} filter.</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/48756">48756</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/48756","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-08-07 19:23:04 +0000 (Fri, 07 Aug 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'>Docs: Correct usage of the dynamic auto_update_{$type} filter.
This ensures that the canonical name of the filter is used in Site Health debug data, as well as on plugin and theme screens, so the developer reference site remains correct.
This brings the changes from <a href="https://core.trac.wordpress.org/changeset/48750">[48750]</a> to the 5.5 branch.
Props johnbillion.
Fixes <a href="https://core.trac.wordpress.org/ticket/50868">#50868</a>, see <a href="https://core.trac.wordpress.org/changeset/48750">[48750]</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches55srcwpadminincludesclasswpautomaticupdaterphp">branches/5.5/src/wp-admin/includes/class-wp-automatic-updater.php</a></li>
<li><a href="#branches55srcwpadminincludesclasswpdebugdataphp">branches/5.5/src/wp-admin/includes/class-wp-debug-data.php</a></li>
<li><a href="#branches55srcwpadminincludesclasswppluginslisttablephp">branches/5.5/src/wp-admin/includes/class-wp-plugins-list-table.php</a></li>
<li><a href="#branches55srcwpadminincludesclasswpsitehealthphp">branches/5.5/src/wp-admin/includes/class-wp-site-health.php</a></li>
<li><a href="#branches55srcwpadminincludesthemephp">branches/5.5/src/wp-admin/includes/theme.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches55">branches/5.5/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.5
</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/5.5 2020-08-07 19:18:19 UTC (rev 48755)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.5 2020-08-07 19:23:04 UTC (rev 48756)
</ins><a id="branches55"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.5</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.4:21757
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:48685-48686,48688-48689,48696,48701,48703,48707,48717,48719,48721,48725-48726,48729-48731,48734,48736,48742,48745,48748-48749,48751
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:48685-48686,48688-48689,48696,48701,48703,48707,48717,48719,48721,48725-48726,48729-48731,48734,48736,48742,48745,48748-48751
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches55srcwpadminincludesclasswpautomaticupdaterphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.5/src/wp-admin/includes/class-wp-automatic-updater.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.5/src/wp-admin/includes/class-wp-automatic-updater.php 2020-08-07 19:18:19 UTC (rev 48755)
+++ branches/5.5/src/wp-admin/includes/class-wp-automatic-updater.php 2020-08-07 19:23:04 UTC (rev 48756)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -179,8 +179,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to automatically update core, a plugin, a theme, or a language.
</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, `$type`, refers to the type of update
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * being checked. Can be 'core', 'theme', 'plugin', or 'translation'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * being checked. Potential hook 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">+ * - `auto_update_core`
+ * - `auto_update_plugin`
+ * - `auto_update_theme`
+ * - `auto_update_translation`
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * Generally speaking, plugins, themes, and major core versions are not updated
</span><span class="cx" style="display: block; padding: 0 10px"> * by default, while translations and minor and development versions for core
</span><span class="cx" style="display: block; padding: 0 10px"> * are updated by default.
</span></span></pre></div>
<a id="branches55srcwpadminincludesclasswpdebugdataphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.5/src/wp-admin/includes/class-wp-debug-data.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.5/src/wp-admin/includes/class-wp-debug-data.php 2020-08-07 19:18:19 UTC (rev 48755)
+++ branches/5.5/src/wp-admin/includes/class-wp-debug-data.php 2020-08-07 19:23:04 UTC (rev 48756)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -971,8 +971,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $item = array_merge( $item, array_intersect_key( $plugin, $item ) );
</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">- /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
- $auto_update_forced = apply_filters( 'auto_update_plugin', null, (object) $item );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $type = 'plugin';
+ /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
+ $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $auto_update_forced ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $enabled = $auto_update_forced;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1114,8 +1115,9 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
- $auto_update_forced = apply_filters( 'auto_update_theme', null, (object) $item );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $type = 'theme';
+ /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
+ $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $auto_update_forced ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $enabled = $auto_update_forced;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1201,8 +1203,9 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
- $auto_update_forced = apply_filters( 'auto_update_theme', null, (object) $item );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $type = 'theme';
+ /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
+ $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $auto_update_forced ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $enabled = $auto_update_forced;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1290,8 +1293,9 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
- $auto_update_forced = apply_filters( 'auto_update_theme', null, (object) $item );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $type = 'theme';
+ /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
+ $auto_update_forced = apply_filters( "auto_update_{$type}", null, (object) $item );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $auto_update_forced ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $enabled = $auto_update_forced;
</span></span></pre></div>
<a id="branches55srcwpadminincludesclasswppluginslisttablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.5/src/wp-admin/includes/class-wp-plugins-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.5/src/wp-admin/includes/class-wp-plugins-list-table.php 2020-08-07 19:18:19 UTC (rev 48755)
+++ branches/5.5/src/wp-admin/includes/class-wp-plugins-list-table.php 2020-08-07 19:23:04 UTC (rev 48756)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -231,8 +231,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $filter_payload = (object) array_merge( $filter_payload, array_intersect_key( $plugin_data, $filter_payload ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
- $auto_update_forced = apply_filters( 'auto_update_plugin', null, $filter_payload );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $type = 'plugin';
+ /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
+ $auto_update_forced = apply_filters( "auto_update_{$type}", null, $filter_payload );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $auto_update_forced ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_data['auto-update-forced'] = $auto_update_forced;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches55srcwpadminincludesclasswpsitehealthphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.5/src/wp-admin/includes/class-wp-site-health.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.5/src/wp-admin/includes/class-wp-site-health.php 2020-08-07 19:18:19 UTC (rev 48755)
+++ branches/5.5/src/wp-admin/includes/class-wp-site-health.php 2020-08-07 19:23:04 UTC (rev 48756)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2372,10 +2372,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'requires_php' => '5.6.20',
</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">+ $type = 'plugin';
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $test_plugins_enabled = apply_filters( 'auto_update_plugin', true, $mock_plugin );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $test_plugins_enabled = apply_filters( "auto_update_{$type}", true, $mock_plugin );
+
+ $type = 'theme';
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $test_themes_enabled = apply_filters( 'auto_update_theme', true, $mock_theme );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $test_themes_enabled = apply_filters( "auto_update_{$type}", true, $mock_theme );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $ui_enabled_for_plugins = wp_is_auto_update_enabled_for_type( 'plugin' );
</span><span class="cx" style="display: block; padding: 0 10px"> $ui_enabled_for_themes = wp_is_auto_update_enabled_for_type( 'theme' );
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_filter_present = has_filter( 'auto_update_plugin' );
</span></span></pre></div>
<a id="branches55srcwpadminincludesthemephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.5/src/wp-admin/includes/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.5/src/wp-admin/includes/theme.php 2020-08-07 19:18:19 UTC (rev 48755)
+++ branches/5.5/src/wp-admin/includes/theme.php 2020-08-07 19:23:04 UTC (rev 48756)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -716,8 +716,9 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This action is documented in wp-admin/includes/class-wp-automatic-updater.php */
- $auto_update_forced = apply_filters( 'auto_update_theme', null, $auto_update_filter_payload );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $type = 'theme';
+ /** This filter is documented in wp-admin/includes/class-wp-automatic-updater.php */
+ $auto_update_forced = apply_filters( "auto_update_{$type}", null, $auto_update_filter_payload );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_themes[ $slug ] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => $slug,
</span></span></pre>
</div>
</div>
</body>
</html>