Changeset 43882 for branches/5.0

Timestamp:

11/09/2018 09:05:47 AM (6 years ago)

Author:

pento

Message:

Meta Boxes: Add the block_editor_meta_box_hidden_fields action.

Lacking an appropriate action in the classic editor, plugins that add meta boxes have historically hooked into various actions in order to add hidden input fields.

This change also adds backwards compatibility for two of the most common: edit_form_after_title, and edit_form_advanced.

Props pento, danielbachhuber.
See #45283.

Location:

branches/5.0/src/wp-admin

Files:

• edit-form-blocks.php (modified) (1 diff)
• includes/post.php (modified) (2 diffs)

branches/5.0/src/wp-admin/edit-form-blocks.php

@@ -387 +387 @@
 register_and_do_post_meta_boxes( $post );
 
-// Some meta boxes hook into the 'edit_form_advanced' filter.
-/** This action is documented in wp-admin/edit-form-advanced.php */
-do_action( 'edit_form_advanced', $post );
-
 require_once( ABSPATH . 'wp-admin/admin-header.php' );
 ?>

branches/5.0/src/wp-admin/includes/post.php

@@ -2186 +2186 @@
     $user_id      = $current_user->ID;
     wp_nonce_field( $nonce_action );
+
+    /*
+     * Some meta boxes hook into these actions to add hidden input fields in the classic post form. For backwards
+     * compatibility, we can capture the output from these actions, and extract the hidden input fields.
+     */
+    $actions = array(
+        'edit_form_after_title',
+        'edit_form_advanced',
+    );
+
+    foreach ( $actions as $action ) {
+        ob_start();
+        do_action_deprecated(
+            $action,
+            array( $post ),
+            '5.0.0',
+            'block_editor_meta_box_hidden_fields',
+            __( 'This action is still supported in the classic editor, but is deprecated in the block editor.' )
+        );
+        $classic_output = ob_get_clean();
+
+        if ( ! $classic_output ) {
+            continue;
+        }
+
+        $classic_elements = wp_html_split( $classic_output );
+        $hidden_inputs    = '';
+        foreach( $classic_elements as $element ) {
+            if ( 0 !== strpos( $element, '<input ') ) {
+                continue;
+            }
+
+            if ( preg_match( '/\stype=[\'"]hidden[\'"]\s/', $element ) ) {
+                echo $element;
+            }
+        }
+    }
     ?>
     <input type="hidden" id="user-id" name="user_ID" value="<?php echo (int) $user_id; ?>" />
@@ -2203 +2240 @@
     // Permalink title nonce.
     wp_nonce_field( 'samplepermalink', 'samplepermalinknonce', false );
-}
+
+    /**
+     * Add hidden input fields to the meta box save form.
+     *
+     * Hook into this action to print `<input type="hidden" ... />` fields, which will be POSTed back to
+     * the server when meta boxes are saved.
+     *
+     * @since 5.0.0
+     *
+     * @params WP_Post $post The post that is being edited.
+     */
+    do_action( 'block_editor_meta_box_hidden_fields', $post );
+}