mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-31 01:59:47 +02:00
a5478d7adb
* The way that the JS modules for media are currently set up turns the existing global `wp.media` namespace into a read-only API, this is bad. * For the existing module implementation to work with plugins, those looking to override or extend a class would have to modify their own plugin to use `browserify` - we can't expect this to happen * Because the general way that plugins override media classes is via machete (resetting them to something else), we cannot use `require( 'module' )` in the internal code for media modules We CAN continue to use `require( 'fun/js' )` in the manifests for media. Future code/projects should carefully consider what is made to be public API. In 3.5, EVERYTHING was made public, so everything shall remain public. See #31684, #28510. Built from https://develop.svn.wordpress.org/trunk@31935 git-svn-id: http://core.svn.wordpress.org/trunk@31914 1a063a9b-81f0-0310-95a4-ce76da25c4cd
123 lines
5.0 KiB
JavaScript
123 lines
5.0 KiB
JavaScript
/*globals wp, _ */
|
|
|
|
/**
|
|
* wp.media.controller.FeaturedImage
|
|
*
|
|
* A state for selecting a featured image for a post.
|
|
*
|
|
* @class
|
|
* @augments wp.media.controller.Library
|
|
* @augments wp.media.controller.State
|
|
* @augments Backbone.Model
|
|
*
|
|
* @param {object} [attributes] The attributes hash passed to the state.
|
|
* @param {string} [attributes.id=featured-image] Unique identifier.
|
|
* @param {string} [attributes.title=Set Featured Image] Title for the state. Displays in the media menu and the frame's title region.
|
|
* @param {wp.media.model.Attachments} [attributes.library] The attachments collection to browse.
|
|
* If one is not supplied, a collection of all images will be created.
|
|
* @param {boolean} [attributes.multiple=false] Whether multi-select is enabled.
|
|
* @param {string} [attributes.content=upload] Initial mode for the content region.
|
|
* Overridden by persistent user setting if 'contentUserSetting' is true.
|
|
* @param {string} [attributes.menu=default] Initial mode for the menu region.
|
|
* @param {string} [attributes.router=browse] Initial mode for the router region.
|
|
* @param {string} [attributes.toolbar=featured-image] Initial mode for the toolbar region.
|
|
* @param {int} [attributes.priority=60] The priority for the state link in the media menu.
|
|
* @param {boolean} [attributes.searchable=true] Whether the library is searchable.
|
|
* @param {boolean|string} [attributes.filterable=false] Whether the library is filterable, and if so what filters should be shown.
|
|
* Accepts 'all', 'uploaded', or 'unattached'.
|
|
* @param {boolean} [attributes.sortable=true] Whether the Attachments should be sortable. Depends on the orderby property being set to menuOrder on the attachments collection.
|
|
* @param {boolean} [attributes.autoSelect=true] Whether an uploaded attachment should be automatically added to the selection.
|
|
* @param {boolean} [attributes.describe=false] Whether to offer UI to describe attachments - e.g. captioning images in a gallery.
|
|
* @param {boolean} [attributes.contentUserSetting=true] Whether the content region's mode should be set and persisted per user.
|
|
* @param {boolean} [attributes.syncSelection=true] Whether the Attachments selection should be persisted from the last state.
|
|
*/
|
|
var Attachment = wp.media.model.Attachment,
|
|
Library = wp.media.controller.Library,
|
|
l10n = wp.media.view.l10n,
|
|
FeaturedImage;
|
|
|
|
FeaturedImage = Library.extend({
|
|
defaults: _.defaults({
|
|
id: 'featured-image',
|
|
title: l10n.setFeaturedImageTitle,
|
|
multiple: false,
|
|
filterable: 'uploaded',
|
|
toolbar: 'featured-image',
|
|
priority: 60,
|
|
syncSelection: true
|
|
}, Library.prototype.defaults ),
|
|
|
|
/**
|
|
* @since 3.5.0
|
|
*/
|
|
initialize: function() {
|
|
var library, comparator;
|
|
|
|
// If we haven't been provided a `library`, create a `Selection`.
|
|
if ( ! this.get('library') ) {
|
|
this.set( 'library', wp.media.query({ type: 'image' }) );
|
|
}
|
|
|
|
Library.prototype.initialize.apply( this, arguments );
|
|
|
|
library = this.get('library');
|
|
comparator = library.comparator;
|
|
|
|
// Overload the library's comparator to push items that are not in
|
|
// the mirrored query to the front of the aggregate collection.
|
|
library.comparator = function( a, b ) {
|
|
var aInQuery = !! this.mirroring.get( a.cid ),
|
|
bInQuery = !! this.mirroring.get( b.cid );
|
|
|
|
if ( ! aInQuery && bInQuery ) {
|
|
return -1;
|
|
} else if ( aInQuery && ! bInQuery ) {
|
|
return 1;
|
|
} else {
|
|
return comparator.apply( this, arguments );
|
|
}
|
|
};
|
|
|
|
// Add all items in the selection to the library, so any featured
|
|
// images that are not initially loaded still appear.
|
|
library.observe( this.get('selection') );
|
|
},
|
|
|
|
/**
|
|
* @since 3.5.0
|
|
*/
|
|
activate: function() {
|
|
this.updateSelection();
|
|
this.frame.on( 'open', this.updateSelection, this );
|
|
|
|
Library.prototype.activate.apply( this, arguments );
|
|
},
|
|
|
|
/**
|
|
* @since 3.5.0
|
|
*/
|
|
deactivate: function() {
|
|
this.frame.off( 'open', this.updateSelection, this );
|
|
|
|
Library.prototype.deactivate.apply( this, arguments );
|
|
},
|
|
|
|
/**
|
|
* @since 3.5.0
|
|
*/
|
|
updateSelection: function() {
|
|
var selection = this.get('selection'),
|
|
id = wp.media.view.settings.post.featuredImageId,
|
|
attachment;
|
|
|
|
if ( '' !== id && -1 !== id ) {
|
|
attachment = Attachment.get( id );
|
|
attachment.fetch();
|
|
}
|
|
|
|
selection.reset( attachment ? [ attachment ] : [] );
|
|
}
|
|
});
|
|
|
|
module.exports = FeaturedImage;
|