WordPress.org

Make WordPress Core


Ignore:
Timestamp:
10/22/2018 02:31:38 AM (3 years ago)
Author:
pento
Message:

Meta Boxes: Add __back_compat_meta_box and __block_editor_compatible_meta_box flags to meta boxes.

When meta boxes are registered, they can use the __back_compat_meta_box and __block_editor_compatible_meta_box flags, to show whether this registration just exists for if the classic editor is loaded, and whether this meta box is compatible with the block editor.

When a meta box marks itself as incompatible with the block editor, and WP_DEBUG is enabled, a warning will show inside that meta box in the classic editor.

As all core meta boxes have been recreated in the block editor, they can be marked with the __back_compat_meta_box flag.

See #45112.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/5.0/src/wp-admin/includes/template.php

    r43496 r43779  
    10521052                    if ( false == $box || ! $box['title'] )
    10531053                        continue;
     1054
     1055                    // Don't show boxes in the block editor, if they're just here for back compat.
     1056                    if ( $screen->is_block_editor() && isset( $box['args']['__back_compat_meta_box'] ) && $box['args']['__back_compat_meta_box'] ) {
     1057                        continue;
     1058                    }
     1059
     1060                    // Don't show boxes in the block editor that aren't compatible with the block editor.
     1061                    if ( $screen->is_block_editor() && isset( $box['args']['__block_editor_compatible_meta_box'] ) && ! $box['args']['__block_editor_compatible_meta_box'] ) {
     1062                        continue;
     1063                    }
     1064
     1065                    $block_compatible = true;
     1066                    if ( isset( $box['args']['__block_editor_compatible_meta_box'] ) ) {
     1067                        $block_compatible = (bool) $box['args']['__block_editor_compatible_meta_box'];
     1068                        unset( $box['args']['__block_editor_compatible_meta_box'] );
     1069                    }
     1070
     1071                    if ( isset( $box['args']['__back_compat_meta_box'] ) ) {
     1072                        $block_compatible |= (bool) $box['args']['__back_compat_meta_box'];
     1073                        unset( $box['args']['__back_compat_meta_box'] );
     1074                    }
     1075
    10541076                    $i++;
    10551077                    $hidden_class = in_array($box['id'], $hidden) ? ' hide-if-js' : '';
     
    10711093                    echo "<h2 class='hndle'><span>{$box['title']}</span></h2>\n";
    10721094                    echo '<div class="inside">' . "\n";
     1095
     1096                    if ( WP_DEBUG && ! $screen->is_block_editor() && ! isset( $_GET['meta-box-loader'] ) ) {
     1097                        if ( is_array( $box['callback'] ) ) {
     1098                            $reflection = new ReflectionMethod( $box['callback'][0], $box['callback'][1] );
     1099                        } else {
     1100                            $reflection = new ReflectionFunction( $box['callback'] );
     1101                        }
     1102
     1103                        // Don't show an error if it's an internal PHP function.
     1104                        if ( ! $reflection->isInternal() ) {
     1105
     1106                            // Only show errors if the meta box was registered by a plugin.
     1107                            $filename = $reflection->getFileName();
     1108                            if ( strpos( $filename, WP_PLUGIN_DIR ) === 0 ) {
     1109                                $filename = str_replace( WP_PLUGIN_DIR, '', $filename );
     1110                                $filename = preg_replace( '|^/([^/]*/).*$|', '\\1', $filename );
     1111
     1112                                $plugins = get_plugins();
     1113                                foreach ( $plugins as $name => $plugin ) {
     1114                                    if ( strpos( $name, $filename ) === 0 ) {
     1115                                        ?>
     1116                                            <div class="error inline">
     1117                                                <p>
     1118                                                    <?php
     1119                                                        /* translators: %s: the name of the plugin that generated this meta box. */
     1120                                                        printf( __( "This meta box, from the %s plugin, isn't compatible with the block editor." ), "<strong>{$plugin['Name']}</strong>" );
     1121                                                    ?>
     1122                                                </p>
     1123                                            </div>
     1124                                        <?php
     1125                                    }
     1126                                }
     1127                            }
     1128                        }
     1129                    }
     1130
    10731131                    call_user_func($box['callback'], $object, $box);
    10741132                    echo "</div>\n";
Note: See TracChangeset for help on using the changeset viewer.