Changeset 38436 for trunk/src/wp-includes/class-wp-customize-nav-menus.php

Timestamp:

08/29/2016 10:58:32 PM (9 years ago)

Author:

westonruter

Message:

Customize: Allow users to more seamlessly create page-based nav menus during customization.

Introduces the ability to create stubs for the various post types to add to a given menu. This eliminates the need to leave the customizer to first create the post in the admin and then return to managing menus. Only the title of the newly-created post can be supplied; the post content will be blank and will need to be provided in the normal edit post screen outside the customizer, unless a plugin enables a post editing in the customizer experience. When a post is created and added to a nav menu in the customizer, the newly created post that is added to a menu is given the auto-draft status, and if the changes are not published, the auto-draft post will be automatically deleted within 7 days via wp_delete_auto_drafts(). However, if the customizer changes are saved, then these nav menu item auto-draft post stubs will be transitioned to publish.

Includes portions of code from the Customize Posts <​https://github.com/xwp/wp-customize-posts> and Front-end Editor <​https://github.com/iseulde/wp-front-end-editor> plugins.

For more information, see ​https://make.wordpress.org/core/2016/06/16/feature-proposal-content-authorship-in-menus-with-live-preview/

Props celloexpressions, westonruter, valendesigns, afercia, melchoyce, mapk, iseulde, mrahmadawais.
Fixes #34923.

File:

• trunk/src/wp-includes/class-wp-customize-nav-menus.php (modified) (12 diffs)

trunk/src/wp-includes/class-wp-customize-nav-menus.php

@@ -57 +57 @@
         add_action( 'wp_ajax_load-available-menu-items-customizer', array( $this, 'ajax_load_available_items' ) );
         add_action( 'wp_ajax_search-available-menu-items-customizer', array( $this, 'ajax_search_available_items' ) );
+        add_action( 'wp_ajax_customize-nav-menus-insert-auto-draft', array( $this, 'ajax_insert_auto_draft_post' ) );
         add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
-
-        // Needs to run after core Navigation section is set up.
         add_action( 'customize_register', array( $this, 'customize_register' ), 11 );
-
         add_filter( 'customize_dynamic_setting_args', array( $this, 'filter_dynamic_setting_args' ), 10, 2 );
         add_filter( 'customize_dynamic_setting_class', array( $this, 'filter_dynamic_setting_class' ), 10, 3 );
@@ -67 +65 @@
         add_action( 'customize_controls_print_footer_scripts', array( $this, 'available_items_template' ) );
         add_action( 'customize_preview_init', array( $this, 'customize_preview_init' ) );
+        add_action( 'customize_preview_init', array( $this, 'make_auto_draft_status_previewable' ) );
+        add_action( 'customize_save_nav_menus_created_posts', array( $this, 'save_nav_menus_created_posts' ) );
 
         // Selective Refresh partials.
@@ -627 +627 @@
             'settings' => array(),
         ) ) );
+
+        $this->manager->add_setting( new WP_Customize_Filter_Setting( $this->manager, 'nav_menus_created_posts', array(
+            'transport' => 'postMessage',
+            'default' => array(),
+            'sanitize_callback' => array( $this, 'sanitize_nav_menus_created_posts' ),
+        ) ) );
     }
 
@@ -649 +655 @@
      *
      * @since 4.3.0
+     * @since 4.7.0  Each array item now includes a `$type_label` in in addition to `$title`, `$type`, and `$object`.
      * @access public
      *
@@ -661 +668 @@
                 $item_types[] = array(
                     'title'  => $post_type->labels->name,
-                    'type'   => 'post_type',
+                    'type_label' => $post_type->labels->singular_name,
+                    'type' => 'post_type',
                     'object' => $post_type->name,
                 );
@@ -674 +682 @@
                 }
                 $item_types[] = array(
-                    'title'  => $taxonomy->labels->name,
-                    'type'   => 'taxonomy',
+                    'title' => $taxonomy->labels->name,
+                    'type_label' => $taxonomy->labels->singular_name,
+                    'type' => 'taxonomy',
                     'object' => $taxonomy->name,
                 );
@@ -685 +694 @@
          *
          * @since 4.3.0
+         * @since 4.7.0  Each array item now includes a `$type_label` in in addition to `$title`, `$type`, and `$object`.
          *
          * @param array $item_types Custom menu item types.
@@ -691 +701 @@
 
         return $item_types;
+    }
+
+    /**
+     * Add a new `auto-draft` post.
+     *
+     * @access public
+     * @since 4.7.0
+     *
+     * @param array $postarr {
+     *     Abbreviated post array.
+     *
+     *     @var string $post_title Post title.
+     *     @var string $post_type  Post type.
+     * }
+     * @return WP_Post|WP_Error Inserted auto-draft post object or error.
+     */
+    public function insert_auto_draft_post( $postarr ) {
+        if ( ! isset( $postarr['post_type'] ) || ! post_type_exists( $postarr['post_type'] )  ) {
+            return new WP_Error( 'unknown_post_type', __( 'Unknown post type' ) );
+        }
+        if ( ! isset( $postarr['post_title'] ) ) {
+            $postarr['post_title'] = '';
+        }
+
+        add_filter( 'wp_insert_post_empty_content', '__return_false', 1000 );
+        $args = array(
+            'post_status' => 'auto-draft',
+            'post_type'   => $postarr['post_type'],
+            'post_title'  => $postarr['post_title'],
+            'post_name'   => sanitize_title( $postarr['post_title'] ), // Auto-drafts are allowed to have empty post_names, so we need to explicitly set it.
+        );
+        $r = wp_insert_post( wp_slash( $args ), true );
+        remove_filter( 'wp_insert_post_empty_content', '__return_false', 1000 );
+
+        if ( is_wp_error( $r ) ) {
+            return $r;
+        } else {
+            return get_post( $r );
+        }
+    }
+
+    /**
+     * Ajax handler for adding a new auto-draft post.
+     *
+     * @access public
+     * @since 4.7.0
+     */
+    public function ajax_insert_auto_draft_post() {
+        if ( ! check_ajax_referer( 'customize-menus', 'customize-menus-nonce', false ) ) {
+            status_header( 400 );
+            wp_send_json_error( 'bad_nonce' );
+        }
+
+        if ( ! current_user_can( 'customize' ) ) {
+            status_header( 403 );
+            wp_send_json_error( 'customize_not_allowed' );
+        }
+
+        if ( empty( $_POST['params'] ) || ! is_array( $_POST['params'] ) ) {
+            status_header( 400 );
+            wp_send_json_error( 'missing_params' );
+        }
+
+        $params = wp_array_slice_assoc(
+            array_merge(
+                array(
+                    'post_type' => '',
+                    'post_title' => '',
+                ),
+                wp_unslash( $_POST['params'] )
+            ),
+            array( 'post_type', 'post_title' )
+        );
+
+        if ( empty( $params['post_type'] ) || ! post_type_exists( $params['post_type'] ) ) {
+            status_header( 400 );
+            wp_send_json_error( 'missing_post_type_param' );
+        }
+
+        $post_type_object = get_post_type_object( $params['post_type'] );
+        if ( ! current_user_can( $post_type_object->cap->create_posts ) || ! current_user_can( $post_type_object->cap->publish_posts ) ) {
+            status_header( 403 );
+            wp_send_json_error( 'insufficient_post_permissions' );
+        }
+
+        $params['post_title'] = trim( $params['post_title'] );
+        if ( '' === $params['post_title'] ) {
+            status_header( 400 );
+            wp_send_json_error( 'missing_post_title' );
+        }
+
+        $r = $this->insert_auto_draft_post( $params );
+        if ( is_wp_error( $r ) ) {
+            $error = $r;
+            if ( ! empty( $post_type_object->labels->singular_name ) ) {
+                $singular_name = $post_type_object->labels->singular_name;
+            } else {
+                $singular_name = __( 'Post' );
+            }
+
+            $data = array(
+                /* translators: %1$s is the post type name and %2$s is the error message. */
+                'message' => sprintf( __( '%1$s could not be created: %2$s' ), $singular_name, $error->get_error_message() ),
+            );
+            wp_send_json_error( $data );
+        } else {
+            $post = $r;
+            $data = array(
+                'post_id' => $post->ID,
+                'url'     => get_permalink( $post->ID ),
+            );
+            wp_send_json_success( $data );
+        }
     }
 
@@ -769 +892 @@
                 </div>
                 <button type="button" class="clear-results"><span class="screen-reader-text"><?php _e( 'Clear Results' ); ?></span></button>
-                <ul class="accordion-section-content" data-type="search"></ul>
+                <ul class="accordion-section-content available-menu-items-list" data-type="search"></ul>
             </div>
             <div id="new-custom-menu-item" class="accordion-section">
@@ -798 +921 @@
             </div>
             <?php
-            // Containers for per-post-type item browsing; items added with JS.
+
+            // Containers for per-post-type item browsing; items are added with JS.
             foreach ( $this->available_item_types() as $available_item_type ) {
                 $id = sprintf( 'available-menu-items-%s-%s', $available_item_type['type'], $available_item_type['object'] );
@@ -814 +938 @@
                         </button>
                     </h4>
-                    <ul class="accordion-section-content" data-type="<?php echo esc_attr( $available_item_type['type'] ); ?>" data-object="<?php echo esc_attr( $available_item_type['object'] ); ?>"></ul>
+                    <div class="accordion-section-content">
+                        <?php if ( 'post_type' === $available_item_type['type'] ) : ?>
+                            <?php $post_type_obj = get_post_type_object( $available_item_type['object'] ); ?>
+                            <?php if ( current_user_can( $post_type_obj->cap->create_posts ) && current_user_can( $post_type_obj->cap->publish_posts ) ) : ?>
+                                <div class="new-content-item">
+                                    <input type="text" class="create-item-input" placeholder="<?php
+                                    /* translators: %s: Singular title of post type or taxonomy */
+                                    printf( __( 'Create New %s' ), $post_type_obj->labels->singular_name ); ?>">
+                                    <button type="button" class="button add-content"><?php _e( 'Add' ); ?></button>
+                                </div>
+                            <?php endif; ?>
+                        <?php endif; ?>
+                        <ul class="available-menu-items-list" data-type="<?php echo esc_attr( $available_item_type['type'] ); ?>" data-object="<?php echo esc_attr( $available_item_type['object'] ); ?>" data-type_label="<?php echo esc_attr( isset( $available_item_type['type_label'] ) ? $available_item_type['type_label'] : $available_item_type['type'] ); ?>"></ul>
+                    </div>
                 </div>
                 <?php
@@ -879 +1016 @@
         add_filter( 'wp_footer', array( $this, 'export_preview_data' ), 1 );
         add_filter( 'customize_render_partials_response', array( $this, 'export_partial_rendered_nav_menu_instances' ) );
+    }
+
+    /**
+     * Make the auto-draft status protected so that it can be queried.
+     *
+     * @since 4.7.0
+     * @access public
+     */
+    public function make_auto_draft_status_previewable() {
+        global $wp_post_statuses;
+        $wp_post_statuses['auto-draft']->protected = true;
+    }
+
+    /**
+     * Sanitize post IDs for auto-draft posts created for nav menu items to be published.
+     *
+     * @since 4.7.0
+     * @access public
+     *
+     * @param array $value Post IDs.
+     * @returns array Post IDs.
+     */
+    public function sanitize_nav_menus_created_posts( $value ) {
+        $post_ids = array();
+        foreach ( wp_parse_id_list( $value ) as $post_id ) {
+            if ( empty( $post_id ) ) {
+                continue;
+            }
+            $post = get_post( $post_id );
+            if ( 'auto-draft' !== $post->post_status ) {
+                continue;
+            }
+            $post_type_obj = get_post_type_object( $post->post_type );
+            if ( ! $post_type_obj ) {
+                continue;
+            }
+            if ( ! current_user_can( $post_type_obj->cap->publish_posts ) || ! current_user_can( $post_type_obj->cap->edit_post, $post_id ) ) {
+                continue;
+            }
+            $post_ids[] = $post->ID;
+        }
+        return $post_ids;
+    }
+
+    /**
+     * Publish the auto-draft posts that were created for nav menu items.
+     *
+     * The post IDs will have been sanitized by already by
+     * `WP_Customize_Nav_Menu_Items::sanitize_nav_menus_created_posts()` to
+     * remove any post IDs for which the user cannot publish or for which the
+     * post is not an auto-draft.
+     *
+     * @since 4.7.0
+     * @access public
+     *
+     * @param WP_Customize_Setting $setting Customizer setting object.
+     */
+    public function save_nav_menus_created_posts( $setting ) {
+        $post_ids = $setting->post_value();
+        if ( ! empty( $post_ids ) ) {
+            foreach ( $post_ids as $post_id ) {
+                wp_publish_post( $post_id );
+            }
+        }
     }