Changeset 44244

Timestamp:

12/16/2018 11:23:38 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Block Editor: Hide the Custom Fields meta box option if that meta box has been removed.

Some plugins remove the Custom Fields meta box, particularly when they provide functionality that replaces it. The block editor would correctly not display this meta box in these circumstances, but it still showed the option to display or hide it.

Props pento, noisysocks.
Merges [43885] to trunk.
See #45282.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/wp-admin/edit-form-blocks.php (modified) (4 diffs)
• src/wp-admin/includes/meta-boxes.php (modified) (1 diff)
• src/wp-admin/includes/template.php (modified) (1 diff)

trunk/src/wp-admin/edit-form-blocks.php

@@ -20 +20 @@
  * @global string       $title
  * @global array        $editor_styles
- */
-global $post_type, $post_type_object, $post, $title, $editor_styles;
+ * @global array        $wp_meta_boxes
+ */
+global $post_type, $post_type_object, $post, $title, $editor_styles, $wp_meta_boxes;
 
 if ( ! empty( $post_type_object ) ) {
@@ -297 +298 @@
 }
 
+/**
+ * Scripts
+ */
+wp_enqueue_media(
+    array(
+        'post' => $post->ID,
+    )
+);
+wp_enqueue_editor();
+
+/**
+ * Styles
+ */
+wp_enqueue_style( 'wp-edit-post' );
+wp_enqueue_style( 'wp-format-library' );
+
+/**
+ * Fires after block assets have been enqueued for the editing interface.
+ *
+ * Call `add_action` on any hook before 'admin_enqueue_scripts'.
+ *
+ * In the function call you supply, simply use `wp_enqueue_script` and
+ * `wp_enqueue_style` to add your functionality to the block editor.
+ *
+ * @since 5.0.0
+ */
+do_action( 'enqueue_block_editor_assets' );
+
+// In order to duplicate classic meta box behaviour, we need to run the classic meta box actions.
+require_once( ABSPATH . 'wp-admin/includes/meta-boxes.php' );
+register_and_do_post_meta_boxes( $post );
+
+// Check if the Custom Fields meta box has been removed at some point.
+$core_meta_boxes = $wp_meta_boxes[ $current_screen->id ]['normal']['core'];
+if ( ! isset( $core_meta_boxes['postcustom'] ) || ! $core_meta_boxes['postcustom'] ) {
+    unset( $editor_settings['enableCustomFields'] );
+}
+
+/**
+ * Filters the settings to pass to the block editor.
+ *
+ * @since 5.0.0
+ *
+ * @param array   $editor_settings Default editor settings.
+ * @param WP_Post $post            Post being edited.
+ */
+$editor_settings = apply_filters( 'block_editor_settings', $editor_settings, $post );
+
 $init_script = <<<JS
 ( function() {
@@ -307 +356 @@
 JS;
 
-
-/**
- * Filters the settings to pass to the block editor.
- *
- * @since 5.0.0
- *
- * @param array   $editor_settings Default editor settings.
- * @param WP_Post $post            Post being edited.
- */
-$editor_settings = apply_filters( 'block_editor_settings', $editor_settings, $post );
-
 $script = sprintf(
     $init_script,
@@ -326 +364 @@
 );
 wp_add_inline_script( 'wp-edit-post', $script );
-
-/**
- * Scripts
- */
-wp_enqueue_media(
-    array(
-        'post' => $post->ID,
-    )
-);
-wp_enqueue_editor();
-
-/**
- * Styles
- */
-wp_enqueue_style( 'wp-edit-post' );
-wp_enqueue_style( 'wp-format-library' );
-
-/**
- * Fires after block assets have been enqueued for the editing interface.
- *
- * Call `add_action` on any hook before 'admin_enqueue_scripts'.
- *
- * In the function call you supply, simply use `wp_enqueue_script` and
- * `wp_enqueue_style` to add your functionality to the block editor.
- *
- * @since 5.0.0
- */
-do_action( 'enqueue_block_editor_assets' );
-
-// In order to duplicate classic meta box behaviour, we need to run the classic meta box actions.
-require_once( ABSPATH . 'wp-admin/includes/meta-boxes.php' );
-register_and_do_post_meta_boxes( $post );
 
 require_once( ABSPATH . 'wp-admin/admin-header.php' );

trunk/src/wp-admin/includes/meta-boxes.php

@@ -1464 +1464 @@
 
     if ( post_type_supports( $post_type, 'custom-fields' ) ) {
-        add_meta_box( 'postcustom', __( 'Custom Fields' ), 'post_custom_meta_box', null, 'normal', 'core', array( '__back_compat_meta_box' => true ) );
+        $args = array(
+            '__back_compat_meta_box'             => ! (bool) get_user_meta( get_current_user_id(), 'enable_custom_fields', true ),
+            '__block_editor_compatible_meta_box' => true,
+        );
+        add_meta_box( 'postcustom', __( 'Custom Fields' ), 'post_custom_meta_box', null, 'normal', 'core', $args );
     }
 

trunk/src/wp-admin/includes/template.php

@@ -1162 +1162 @@
 
                     $i++;
-                    $hidden_class = in_array( $box['id'], $hidden ) ? ' hide-if-js' : '';
+                    // get_hidden_meta_boxes() doesn't apply in the block editor.
+                    $hidden_class = ( ! $screen->is_block_editor() && in_array( $box['id'], $hidden ) ) ? ' hide-if-js' : '';
                     echo '<div id="' . $box['id'] . '" class="postbox ' . postbox_classes( $box['id'], $page ) . $hidden_class . '" ' . '>' . "\n";
                     if ( 'dashboard_browser_nag' != $box['id'] ) {