Changeset 51145

Timestamp:

06/14/2021 08:49:05 PM (5 years ago)

Author:

joedolson

Message:

Media: Restore AJAX response data shape in media library.

Restore the original shape of the AJAX response data in the media library after removing infinite scroll, and pass total number of attachments in the response headers X-WP-Total and X-WP-TotalPages.

Improve backwards compatibility for plugins intercepting the ajax response. Headers match the structure and count calculation used in REST API responses.

Fix an issue with hiding the spinner after the load is completed and ensure that the load more view is created when changing tabs in the media library modal.

Follow up to [50829].

props adamsilverstein, spacedmonkey, joedolson.
Fixes #50105.

Location:

trunk/src

Files:

• js/_enqueues/wp/util.js (modified) (1 diff)
• js/media/models/attachments.js (modified) (3 diffs)
• js/media/models/query.js (modified) (1 diff)
• js/media/views/attachments/browser.js (modified) (2 diffs)
• wp-admin/includes/ajax-actions.php (modified) (1 diff)

trunk/src/js/_enqueues/wp/util.js

@@ -116 +116 @@
 
                                         if ( _.isObject( response ) && ! _.isUndefined( response.success ) ) {
-                                                deferred[ response.success ? 'resolveWith' : 'rejectWith' ]( this, [response.data] );
+                                                deferred[ response.success ? 'resolveWith' : 'rejectWith' ]( deferred.jqXHR, [response.data] );
                                         } else {
                                                 deferred.rejectWith( this, [response] );

trunk/src/js/media/models/attachments.js

@@ -376 +376 @@
          * the collection items.
          *
-         * @since 5.8.0 The response returns the attachments under `response.attachments` and
-         *              `response.totalAttachments` holds the total number of attachments found.
-         *
          * @param {Object|Array} response The raw response Object/Array.
          * @param {Object} xhr
@@ -384 +381 @@
          */
         parse: function( response, xhr ) {
-                if ( ! _.isArray( response.attachments ) ) {
-                        response = [ response.attachments ];
-                }
-
-                this.totalAttachments = parseInt( response.totalAttachments, 10 );
-
-                return _.map( response.attachments, function( attrs ) {
+                if ( ! _.isArray( response ) ) {
+                          response = [response];
+                }
+                return _.map( response, function( attrs ) {
                         var id, attachment, newAttributes;
 
@@ -410 +404 @@
                 });
         },
+
+        // Customize fetch so we can extract the total post count from the response headers.
+        fetch: function(options) {
+                var collection = this;
+                var fetched = Backbone.Collection.prototype.fetch.call(this, options)
+                        .done( function() {
+                                if ( this.hasOwnProperty( 'getResponseHeader' ) ) {
+                                        collection.totalAttachments = parseInt( this.getResponseHeader( 'X-WP-Total' ), 10 );
+                                } else {
+                                        collection.totalAttachments = 0;
+                                }
+                        } );
+                return fetched;
+        },
+
         /**
          * If the collection is a query, create and mirror an Attachments Query collection.
-         * 
+         *
          * @access private
          * @param {Boolean} refresh Deprecated, refresh parameter no longer used.

trunk/src/js/media/models/query.js

@@ -114 +114 @@
 
                 return this._more = this.fetch( options ).done( function( response ) {
-                        var attachments = response.attachments;
-
-                        if ( _.isEmpty( attachments ) || -1 === this.args.posts_per_page || attachments.length < this.args.posts_per_page ) {
+                        if ( _.isEmpty( response ) || -1 === query.args.posts_per_page || response.length < query.args.posts_per_page ) {
                                 query._hasMore = false;
                         }

trunk/src/js/media/views/attachments/browser.js

@@ -89 +89 @@
 
                 this.updateContent();
+                this.updateLoadMoreView();
 
                 if ( ! this.options.sidebar || 'errors' === this.options.sidebar ) {
@@ -636 +637 @@
 
                 view.loadMoreSpinner.show();
-
-                this.collection.more().done( function() {
-                        // Within done(), `this` is the returned collection.
+                this.collection.once( 'attachments:received', function() {
                         view.loadMoreSpinner.hide();
                 } );
+                this.collection.more();
         },
 

trunk/src/wp-admin/includes/ajax-actions.php

@@ -2991 +2991 @@
          */
         $query = apply_filters( 'ajax_query_attachments_args', $query );
-        $query = new WP_Query( $query );
-
-        $posts = array_map( 'wp_prepare_attachment_for_js', $query->posts );
+        $attachments_query = new WP_Query( $query );
+
+        $posts = array_map( 'wp_prepare_attachment_for_js', $attachments_query->posts );
         $posts = array_filter( $posts );
-
-        $result = array(
-                'attachments'      => $posts,
-                'totalAttachments' => $query->found_posts,
-        );
-
-        wp_send_json_success( $result );
+        $total_posts = $attachments_query->found_posts;
+
+        if ( $total_posts < 1 ) {
+                // Out-of-bounds, run the query again without LIMIT for total count.
+                unset( $query['paged'] );
+
+                $count_query = new WP_Query();
+                $count_query->query( $query_args );
+                $total_posts = $count_query->found_posts;
+        }
+
+        $max_pages = ceil( $total_posts / (int) $attachments_query->query['posts_per_page'] );
+
+        header( 'X-WP-Total: ' . (int) $total_posts );
+        header( 'X-WP-TotalPages: ' . (int) $max_pages );
+
+        wp_send_json_success( $posts );
 }