<!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>[43941] branches/5.0/src/wp-admin/includes: Block Editor: Add a placeholder for meta boxes that don't work in the block editor.</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/43941">43941</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/43941","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-11-23 08:14:07 +0000 (Fri, 23 Nov 2018)</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'>Block Editor: Add a placeholder for meta boxes that don't work in the block editor.
If a meta box is registered with the `__block_editor_compatible_meta_box` set to `false`, it's indicating that it doesn't work in the block editor. If that's the case, we can add a place holder to inform the user that they'll need to use the classic interface to work with this meta box.
Props pento, jorgefilipecosta, peterwilsoncc, karmatosed, noisysocks, dd32.
See <a href="https://core.trac.wordpress.org/ticket/45217">#45217</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpadminincludespostphp">branches/5.0/src/wp-admin/includes/post.php</a></li>
<li><a href="#branches50srcwpadminincludestemplatephp">branches/5.0/src/wp-admin/includes/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpadminincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-admin/includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-admin/includes/post.php 2018-11-23 00:41:56 UTC (rev 43940)
+++ branches/5.0/src/wp-admin/includes/post.php 2018-11-23 08:14:07 UTC (rev 43941)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2110,11 +2110,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">- // If a meta box doesn't work in the block editor, don't show it in the block editor.
- if ( isset( $meta_box['args']['__block_editor_compatible_meta_box'] ) && ! $meta_box['args']['__block_editor_compatible_meta_box'] ) {
- continue;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $meta_boxes_per_location[ $location ][] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => $meta_box['id'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'title' => $meta_box['title'],
</span></span></pre></div>
<a id="branches50srcwpadminincludestemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-admin/includes/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-admin/includes/template.php 2018-11-23 00:41:56 UTC (rev 43940)
+++ branches/5.0/src/wp-admin/includes/template.php 2018-11-23 08:14:07 UTC (rev 43941)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -998,7 +998,106 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_meta_boxes[$page][$context][$priority][$id] = array('id' => $id, 'title' => $title, 'callback' => $callback, 'args' => $callback_args);
</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">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Function that renders a "fake" meta box with an information message,
+ * shown on the block editor, when an incompatible meta box is found.
+ *
+ * @since 5.0.0
+ *
+ * @param mixed $object The data object being rendered on this screen.
+ * @param array $box {
+ * Custom formats meta box arguments.
+ *
+ * @type string $id Meta box 'id' attribute.
+ * @type string $title Meta box title.
+ * @type callable $old_callback The original callback for this meta box.
+ * @type array $args Extra meta box arguments.
+ * }
+ */
+function do_block_editor_incompatible_meta_box( $object, $box ) {
+ $plugin = _get_plugin_from_callback( $box['old_callback'] );
+ $plugins = get_plugins();
+ echo '<p>';
+ if ( $plugin ) {
+ /* translators: %s: the name of the plugin that generated this meta box. */
+ printf( __( "This meta box, from the %s plugin, isn't compatible with the block editor." ), "<strong>{$plugin['Name']}</strong>" );
+ } else {
+ _e( "This meta box isn't compatible with the block editor." );
+ }
+ echo '</p>';
+
+ if ( empty( $plugins['classic-editor/classic-editor.php'] ) ) {
+ if ( current_user_can( 'install_plugins' ) ) {
+ echo '<p>';
+ /* translators: %s: A link to install the Classic Editor plugin. */
+ printf( __( 'Please install the <a href="%s">Classic Editor plugin</a> to use this meta box.'), esc_url( self_admin_url( 'plugin-install.php?tab=featured' ) ) );
+ echo '</p>';
+ }
+ } elseif ( is_plugin_inactive( 'classic-editor/classic-editor.php' ) ) {
+ if ( current_user_can( 'activate_plugins' ) ) {
+ $activate_url = wp_nonce_url( self_admin_url( 'plugins.php?action=activate&plugin=classic-editor/classic-editor.php' ), 'activate-plugin_classic-editor/classic-editor.php' );
+ echo '<p>';
+ /* translators: %s: A link to activate the Classic Editor plugin. */
+ printf( __( 'Please activate the <a href="%s">Classic Editor plugin</a> to use this meta box.'), esc_url( $activate_url ) );
+ echo '</p>';
+ }
+ } elseif ( $object instanceof WP_Post ) {
+ $edit_url = add_query_arg( 'classic-editor', '', get_edit_post_link( $object ) );
+ echo '<p>';
+ /* translators: %s: A link to use the Classic Editor plugin. */
+ printf( __( 'Please open the <a href="%s">classic editor</a> to use this meta box.'), esc_url( $edit_url ) );
+ echo '</p>';
+ }
+}
+
+/**
+ * Internal helper function to find the plugin from a meta box callback.
+ *
+ * @since 5.0.0
+ *
+ * @access private
+ *
+ * @param callable $callback The callback function to check.
+ * @return array|null The plugin that the callback belongs to, or null if it doesn't belong to a plugin.
+ */
+function _get_plugin_from_callback( $callback ) {
+ try {
+ if ( is_array( $callback ) ) {
+ $reflection = new ReflectionMethod( $callback[0], $callback[1] );
+ } elseif ( is_string( $callback) && false !== strpos( $callback, '::' ) ) {
+ $reflection = new ReflectionMethod( $callback );
+ } else {
+ $reflection = new ReflectionFunction( $callback );
+ }
+ } catch ( ReflectionException $exception ) {
+ // We could not properly reflect on the callable, so we abort here.
+ return null;
+ }
+
+ // Don't show an error if it's an internal PHP function.
+ if ( ! $reflection->isInternal() ) {
+
+ // Only show errors if the meta box was registered by a plugin.
+ $filename = wp_normalize_path( $reflection->getFileName() );
+ $plugin_dir = wp_normalize_path( WP_PLUGIN_DIR );
+ if ( strpos( $filename, $plugin_dir ) === 0 ) {
+ $filename = str_replace( $plugin_dir, '', $filename );
+ $filename = preg_replace( '|^/([^/]*/).*$|', '\\1', $filename );
+
+ $plugins = get_plugins();
+ foreach ( $plugins as $name => $plugin ) {
+ if ( strpos( $name, $filename ) === 0 ) {
+ return $plugin;
+ }
+ }
+ }
+ }
+
+ return null;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Meta-Box template function
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1059,16 +1158,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">- // If a meta box doesn't work in the block editor, don't show it in the block editor.
- if ( $screen->is_block_editor() && isset( $box['args']['__block_editor_compatible_meta_box'] ) && ! $box['args']['__block_editor_compatible_meta_box'] ) {
- continue;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $box['args']['__block_editor_compatible_meta_box'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $block_compatible = (bool) $box['args']['__block_editor_compatible_meta_box'];
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $box['args']['__block_editor_compatible_meta_box'] );
</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">+ // If the meta box is declared as incompatible with the block editor, override the callback function.
+ if ( ! $block_compatible && $screen->is_block_editor() ) {
+ $box['old_callback'] = $box['callback'];
+ $box['callback'] = 'do_block_editor_incompatible_meta_box';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $box['args']['__back_compat_meta_box'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $block_compatible = $block_compatible || (bool) $box['args']['__back_compat_meta_box'];
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $box['args']['__back_compat_meta_box'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1097,40 +1197,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<div class="inside">' . "\n";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( WP_DEBUG && ! $block_compatible && 'edit' === $screen->parent_base && ! $screen->is_block_editor() && ! isset( $_GET['meta-box-loader'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_array( $box['callback'] ) ) {
- $reflection = new ReflectionMethod( $box['callback'][0], $box['callback'][1] );
- } elseif ( false !== strpos( $box['callback'], '::' ) ) {
- $reflection = new ReflectionMethod( $box['callback'] );
- } else {
- $reflection = new ReflectionFunction( $box['callback'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $plugin = _get_plugin_from_callback( $box['callback'] );
+ if ( $plugin ) {
+ ?>
+ <div class="error inline">
+ <p>
+ <?php
+ /* translators: %s: the name of the plugin that generated this meta box. */
+ printf( __( "This meta box, from the %s plugin, isn't compatible with the block editor." ), "<strong>{$plugin['Name']}</strong>" );
+ ?>
+ </p>
+ </div>
+ <?php
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // Don't show an error if it's an internal PHP function.
- if ( ! $reflection->isInternal() ) {
-
- // Only show errors if the meta box was registered by a plugin.
- $filename = $reflection->getFileName();
- if ( strpos( $filename, WP_PLUGIN_DIR ) === 0 ) {
- $filename = str_replace( WP_PLUGIN_DIR, '', $filename );
- $filename = preg_replace( '|^/([^/]*/).*$|', '\\1', $filename );
-
- $plugins = get_plugins();
- foreach ( $plugins as $name => $plugin ) {
- if ( strpos( $name, $filename ) === 0 ) {
- ?>
- <div class="error inline">
- <p>
- <?php
- /* translators: %s: the name of the plugin that generated this meta box. */
- printf( __( "This meta box, from the %s plugin, isn't compatible with the block editor." ), "<strong>{$plugin['Name']}</strong>" );
- ?>
- </p>
- </div>
- <?php
- }
- }
- }
- }
</del><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"> call_user_func($box['callback'], $object, $box);
</span></span></pre>
</div>
</div>
</body>
</html>