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

Timestamp:

07/18/2015 11:19:33 PM (10 years ago)

Author:

westonruter

Message:

Customizer: Finish unit tests for nav menus.

Removes object_type restriction to allow for future extensibility. Refactors some methods to improve testability. Includes new tests for Ajax requests.

Fixes #32687.
Props valendesigns, welcher, westonruter.

File:

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

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

@@ -81 +81 @@
 
         $obj_type = sanitize_key( $_POST['obj_type'] );
-        if ( ! in_array( $obj_type, array( 'post_type', 'taxonomy' ) ) ) {
-            wp_send_json_error( 'nav_menus_invalid_obj_type' );
-        }
-
-        $taxonomy_or_post_type = sanitize_key( $_POST['type'] );
-        $page = isset( $_POST['page'] ) ? absint( $_POST['page'] ) : 0;
+        $obj_name = sanitize_key( $_POST['type'] );
+        $page = empty( $_POST['page'] ) ? 0 : absint( $_POST['page'] );
+        $items = $this->load_available_items_query( $obj_type, $obj_name, $page );
+
+        if ( is_wp_error( $items ) ) {
+            wp_send_json_error( $items->get_error_code() );
+        } else {
+            wp_send_json_success( array( 'items' => $items ) );
+        }
+    }
+
+    /**
+     * Performs the post_type and taxonomy queries for loading available menu items.
+     *
+     * @since 4.3.0
+     * @access public
+     *
+     * @param string $obj_type Optional. Accepts any custom object type and has built-in support for
+     *                         'post_type' and 'taxonomy'. Default is 'post_type'.
+     * @param string $obj_name Optional. Accepts any registered taxonomy or post type name. Default is 'page'.
+     * @param int    $page     Optional. The page number used to generate the query offset. Default is '0'.
+     * @return WP_Error|array Returns either a WP_Error object or an array of menu items.
+     */
+    public function load_available_items_query( $obj_type = 'post_type', $obj_name = 'page', $page = 0 ) {
         $items = array();
 
         if ( 'post_type' === $obj_type ) {
-            if ( ! get_post_type_object( $taxonomy_or_post_type ) ) {
-                wp_send_json_error( 'nav_menus_invalid_post_type' );
+            if ( ! get_post_type_object( $obj_name ) ) {
+                return new WP_Error( 'nav_menus_invalid_post_type' );
             }
 
-            if ( 0 === $page && 'page' === $taxonomy_or_post_type ) {
+            if ( 0 === $page && 'page' === $obj_name ) {
                 // Add "Home" link. Treat as a page, but switch to custom on add.
                 $items[] = array(
@@ -111 +129 @@
                 'orderby'     => 'date',
                 'order'       => 'DESC',
-                'post_type'   => $taxonomy_or_post_type,
+                'post_type'   => $obj_name,
             ) );
             foreach ( $posts as $post ) {
@@ -130 +148 @@
             }
         } elseif ( 'taxonomy' === $obj_type ) {
-            $terms = get_terms( $taxonomy_or_post_type, array(
+            $terms = get_terms( $obj_name, array(
                 'child_of'     => 0,
                 'exclude'      => '',
@@ -143 +161 @@
             ) );
             if ( is_wp_error( $terms ) ) {
-                wp_send_json_error( $terms->get_error_code() );
+                return $terms;
             }
 
@@ -159 +177 @@
         }
 
-        wp_send_json_success( array( 'items' => $items ) );
+        return $items;
     }
 
@@ -185 +203 @@
 
         $s = sanitize_text_field( wp_unslash( $_POST['search'] ) );
-        $results = $this->search_available_items_query( array( 'pagenum' => $p, 's' => $s ) );
-
-        if ( empty( $results ) ) {
-            wp_send_json_error( array( 'message' => __( 'No results found.' ) ) );
+        $items = $this->search_available_items_query( array( 'pagenum' => $p, 's' => $s ) );
+
+        if ( empty( $items ) ) {
+            wp_send_json_error( array( 'message' => __( 'No menu items found.' ) ) );
         } else {
-            wp_send_json_success( array( 'items' => $results ) );
+            wp_send_json_success( array( 'items' => $items ) );
         }
     }
@@ -203 +221 @@
      *
      * @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
-     * @return array Results.
+     * @return array Menu items.
      */
     public function search_available_items_query( $args = array() ) {
-        $results = array();
+        $items = array();
 
         $post_type_objects = get_post_types( array( 'show_in_nav_menus' => true ), 'objects' );
@@ -236 +254 @@
                     $post_title = sprintf( __( '#%d (no title)' ), $post->ID );
                 }
-                $results[] = array(
+                $items[] = array(
                     'id'         => 'post-' . $post->ID,
                     'title'      => html_entity_decode( $post_title, ENT_QUOTES, get_bloginfo( 'charset' ) ),
@@ -259 +277 @@
         if ( ! empty( $terms ) ) {
             foreach ( $terms as $term ) {
-                $results[] = array(
+                $items[] = array(
                     'id'         => 'term-' . $term->term_id,
                     'title'      => html_entity_decode( $term->name, ENT_QUOTES, get_bloginfo( 'charset' ) ),
@@ -271 +289 @@
         }
 
-        return $results;
+        return $items;
     }