Changeset 30885

Timestamp:

12/15/2014 11:27:17 PM (10 years ago)

Author:

ocean90

Message:

Customizer: Add _wp_attachment_is_custom_background meta to uploaded background images.

Adds $type property to WP_Customize_Background_Image_Control (PHP) and introduces wp.customize.BackgroundControl (JS).

see #30707.

Location:

trunk/src

Files:

• wp-admin/css/customize-controls.css (modified) (12 diffs)
• wp-admin/custom-background.php (modified) (4 diffs)
• wp-admin/js/customize-controls.js (modified) (3 diffs)
• wp-includes/class-wp-customize-control.php (modified) (3 diffs)
• wp-includes/class-wp-customize-manager.php (modified) (1 diff)

trunk/src/wp-admin/css/customize-controls.css

@@ -582 +582 @@
 .customize-control-upload .current,
 .customize-control-image .current,
+.customize-control-background .current,
 .customize-control-header .current {
     margin-bottom: 8px;
@@ -611 +612 @@
 .customize-control-image .default-button,
 .customize-control-image .upload-button,
+.customize-control-background .remove-button,
+.customize-control-background .default-button,
+.customize-control-background .upload-button,
 .customize-control-header button.new,
 .customize-control-header button.remove {
@@ -620 +624 @@
 .customize-control-upload .current .container,
 .customize-control-image .current .container,
+.customize-control-background .current .container,
 .customize-control-header .current .container {
     overflow: hidden;
@@ -629 +634 @@
 
 .customize-control-upload .current .container,
+.customize-control-background .current .container,
 .customize-control-image .current .container {
     min-height: 40px;
@@ -635 +641 @@
 .customize-control-upload .placeholder,
 .customize-control-image .placeholder,
+.customize-control-background .placeholder,
 .customize-control-header .placeholder {
     width: 100%;
@@ -644 +651 @@
 .customize-control-upload .inner,
 .customize-control-image .inner,
+.customize-control-background .inner,
 .customize-control-header .inner {
     display: none;
@@ -655 +663 @@
 
 .customize-control-upload .inner,
+.customize-control-background .inner,
 .customize-control-image .inner {
     display: block;
@@ -662 +671 @@
 .customize-control-upload .inner,
 .customize-control-image .inner,
+.customize-control-background .inner,
 .customize-control-header .inner,
 .customize-control-header .inner .dashicons {
@@ -778 +788 @@
 .customize-control-upload .actions,
 .customize-control-image .actions,
+.customize-control-background .actions,
 .customize-control-header .actions {
     margin-bottom: 32px;
@@ -794 +805 @@
 .customize-control-upload img,
 .customize-control-image img,
+.customize-control-background img,
 .customize-control-header img {
     width: 100%;
@@ -804 +816 @@
 .customize-control-image .remove-button,
 .customize-control-image .default-button,
+.customize-control-background .remove-button,
+.customize-control-background .default-button,
 .customize-control-header .remove {
     float: left;
@@ -811 +825 @@
 .customize-control-upload .upload-button,
 .customize-control-image .upload-button,
+.customize-control-background .upload-button,
 .customize-control-header .new {
     float: right;

trunk/src/wp-admin/custom-background.php

@@ -61 +61 @@
 
         add_action( 'admin_menu', array( $this, 'init' ) );
+
+        add_action( 'wp_ajax_custom-background-add', array( $this, 'ajax_background_add' ) );
+
+        // Unused since 3.5.0.
         add_action( 'wp_ajax_set-background-image', array( $this, 'wp_set_background_image' ) );
     }
@@ -465 +469 @@
 
     /**
-     * Unused since 3.5.0.
+     * AJAX handler for adding custom background context to an attachment.
+     *
+     * Triggered when the user adds a new background image from the
+     * Media Manager.
+     *
+     * @since 4.1.0
+     */
+    public function ajax_background_add() {
+        check_ajax_referer( 'background-add', 'nonce' );
+
+        if ( ! current_user_can( 'edit_theme_options' ) ) {
+            wp_send_json_error();
+        }
+
+        $attachment_id = absint( $_POST['attachment_id'] );
+        if ( $attachment_id < 1 ) {
+            wp_send_json_error();
+        }
+
+        update_post_meta( $attachment_id, '_wp_attachment_is_custom_background', get_stylesheet() );
+
+        wp_send_json_success();
+    }
+
+    /**
      *
      * @since 3.4.0
+     * @deprecated 3.5.0
      */
     public function attachment_fields_to_edit( $form_fields ) {
@@ -474 +503 @@
 
     /**
-     * Unused since 3.5.0.
      *
      * @since 3.4.0
+     * @deprecated 3.5.0
      */
     public function filter_upload_tabs( $tabs ) {
@@ -482 +511 @@
     }
 
+    /**
+     *
+     * @since 3.4.0
+     * @deprecated 3.5.0
+     */
     public function wp_set_background_image() {
         if ( ! current_user_can('edit_theme_options') || ! isset( $_POST['attachment_id'] ) ) exit;

trunk/src/wp-admin/js/customize-controls.js

@@ -1 @@
-/* globals _wpCustomizeHeader, _wpMediaViewsL10n */
+/* globals _wpCustomizeHeader, _wpCustomizeBackground, _wpMediaViewsL10n */
 (function( exports, $ ){
     var Container, focus, api = wp.customize;
@@ -1145 +1145 @@
 
     /**
+     * A control for uploading background images.
+     *
+     * @class
+     * @augments wp.customize.UploadControl
+     * @augments wp.customize.Control
+     * @augments wp.customize.Class
+     */
+    api.BackgroundControl = api.UploadControl.extend({
+
+        /**
+         * When the control's DOM structure is ready,
+         * set up internal event bindings.
+         */
+        ready: function() {
+            api.UploadControl.prototype.ready.apply( this, arguments );
+        },
+
+        /**
+         * Callback handler for when an attachment is selected in the media modal.
+         * Does an additional AJAX request for setting the background context.
+         */
+        select: function() {
+            api.UploadControl.prototype.select.apply( this, arguments );
+
+            wp.ajax.post( 'custom-background-add', {
+                nonce: _wpCustomizeBackground.nonces.add,
+                wp_customize: 'on',
+                theme: api.settings.theme.stylesheet,
+                attachment_id: this.params.attachment.id
+            } );
+        }
+    });
+
+    /**
      * @class
      * @augments wp.customize.Control
@@ -1823 +1857 @@
         upload: api.UploadControl,
         image:  api.ImageControl,
-        header: api.HeaderControl
+        header: api.HeaderControl,
+        background: api.BackgroundControl
     };
     api.panelConstructor = {};

trunk/src/wp-includes/class-wp-customize-control.php

@@ -880 +880 @@
  */
 class WP_Customize_Background_Image_Control extends WP_Customize_Image_Control {
+    public $type = 'background';
 
     /**
@@ -893 +894 @@
             'label'    => __( 'Background Image' ),
             'section'  => 'background_image',
+        ) );
+    }
+
+    /**
+     * Enqueue control related scripts/styles.
+     *
+     * @since 4.1.0
+     */
+    public function enqueue() {
+        parent::enqueue();
+
+        wp_localize_script( 'customize-controls', '_wpCustomizeBackground', array(
+            'nonces' => array(
+                'add' => wp_create_nonce( 'background-add' ),
+            ),
         ) );
     }
@@ -913 +929 @@
             ),
             'section'  => 'header_image',
-            'context'  => 'custom-header',
             'removed'  => 'remove-header',
             'get_url'  => 'get_header_image',

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -975 +975 @@
         $this->register_control_type( 'WP_Customize_Upload_Control' );
         $this->register_control_type( 'WP_Customize_Image_Control' );
+        $this->register_control_type( 'WP_Customize_Background_Image_Control' );
 
         /* Site Title & Tagline */