wp-admin/custom-background.php

   1 <?php
   2 /**
   3  * The custom background script.
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /**
  10  * The custom background class.
  11  *
  12  * @since 3.0.0
  13  * @package WordPress
  14  * @subpackage Administration
  15  */
  16 class Custom_Background {
  17
  18         /**
  19          * Callback for administration header.
  20          *
  21          * @var callback
  22          * @since 3.0.0
  23          */
  24         public $admin_header_callback;
  25
  26         /**
  27          * Callback for header div.
  28          *
  29          * @var callback
  30          * @since 3.0.0
  31          */
  32         public $admin_image_div_callback;
  33
  34         /**
  35          * @var bool
  36          */
  37         private $updated;
  38
  39         /**
  40          * Constructor - Register administration header callback.
  41          *
  42          * @since 3.0.0
  43          * @param callback $admin_header_callback
  44          * @param callback $admin_image_div_callback Optional custom image div output callback.
  45          */
  46         public function __construct($admin_header_callback = '', $admin_image_div_callback = '') {
  47                 $this->admin_header_callback = $admin_header_callback;
  48                 $this->admin_image_div_callback = $admin_image_div_callback;
  49
  50                 add_action( 'admin_menu', array( $this, 'init' ) );
  51
  52                 add_action( 'wp_ajax_custom-background-add', array( $this, 'ajax_background_add' ) );
  53
  54                 // Unused since 3.5.0.
  55                 add_action( 'wp_ajax_set-background-image', array( $this, 'wp_set_background_image' ) );
  56         }
  57
  58         /**
  59          * Set up the hooks for the Custom Background admin page.
  60          *
  61          * @since 3.0.0
  62          */
  63         public function init() {
  64                 $page = add_theme_page( __( 'Background' ), __( 'Background' ), 'edit_theme_options', 'custom-background', array( $this, 'admin_page' ) );
  65                 if ( ! $page ) {
  66                         return;
  67                 }
  68
  69                 add_action( "load-$page", array( $this, 'admin_load' ) );
  70                 add_action( "load-$page", array( $this, 'take_action' ), 49 );
  71                 add_action( "load-$page", array( $this, 'handle_upload' ), 49 );
  72
  73                 if ( $this->admin_header_callback ) {
  74                         add_action( "admin_head-$page", $this->admin_header_callback, 51 );
  75                 }
  76         }
  77
  78         /**
  79          * Set up the enqueue for the CSS & JavaScript files.
  80          *
  81          * @since 3.0.0
  82          */
  83         public function admin_load() {
  84                 get_current_screen()->add_help_tab( array(
  85                         'id'      => 'overview',
  86                         'title'   => __('Overview'),
  87                         'content' =>
  88                                 '<p>' . __( 'You can customize the look of your site without touching any of your theme&#8217;s code by using a custom background. Your background can be an image or a color.' ) . '</p>' .
  89                                 '<p>' . __( 'To use a background image, simply upload it or choose an image that has already been uploaded to your Media Library by clicking the &#8220;Choose Image&#8221; button. You can display a single instance of your image, or tile it to fill the screen. You can have your background fixed in place, so your site content moves on top of it, or you can have it scroll with your site.' ) . '</p>' .
  90                                 '<p>' . __( 'You can also choose a background color by clicking the Select Color button and either typing in a legitimate HTML hex value, e.g. &#8220;#ff0000&#8221; for red, or by choosing a color using the color picker.' ) . '</p>' .
  91                                 '<p>' . __( 'Don&#8217;t forget to click on the Save Changes button when you are finished.' ) . '</p>'
  92                 ) );
  93
  94                 get_current_screen()->set_help_sidebar(
  95                         '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
  96                         '<p>' . __( '<a href="https://codex.wordpress.org/Appearance_Background_Screen" target="_blank">Documentation on Custom Background</a>' ) . '</p>' .
  97                         '<p>' . __( '<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>' ) . '</p>'
  98                 );
  99
 100                 wp_enqueue_media();
 101                 wp_enqueue_script('custom-background');
 102                 wp_enqueue_style('wp-color-picker');
 103         }
 104
 105         /**
 106          * Execute custom background modification.
 107          *
 108          * @since 3.0.0
 109          */
 110         public function take_action() {
 111
 112                 if ( empty($_POST) )
 113                         return;
 114
 115                 if ( isset($_POST['reset-background']) ) {
 116                         check_admin_referer('custom-background-reset', '_wpnonce-custom-background-reset');
 117                         remove_theme_mod('background_image');
 118                         remove_theme_mod('background_image_thumb');
 119                         $this->updated = true;
 120                         return;
 121                 }
 122
 123                 if ( isset($_POST['remove-background']) ) {
 124                         // @TODO: Uploaded files are not removed here.
 125                         check_admin_referer('custom-background-remove', '_wpnonce-custom-background-remove');
 126                         set_theme_mod('background_image', '');
 127                         set_theme_mod('background_image_thumb', '');
 128                         $this->updated = true;
 129                         wp_safe_redirect( $_POST['_wp_http_referer'] );
 130                         return;
 131                 }
 132
 133                 if ( isset($_POST['background-repeat']) ) {
 134                         check_admin_referer('custom-background');
 135                         if ( in_array($_POST['background-repeat'], array('repeat', 'no-repeat', 'repeat-x', 'repeat-y')) )
 136                                 $repeat = $_POST['background-repeat'];
 137                         else
 138                                 $repeat = 'repeat';
 139                         set_theme_mod('background_repeat', $repeat);
 140                 }
 141
 142                 if ( isset($_POST['background-position-x']) ) {
 143                         check_admin_referer('custom-background');
 144                         if ( in_array($_POST['background-position-x'], array('center', 'right', 'left')) )
 145                                 $position = $_POST['background-position-x'];
 146                         else
 147                                 $position = 'left';
 148                         set_theme_mod('background_position_x', $position);
 149                 }
 150
 151                 if ( isset($_POST['background-attachment']) ) {
 152                         check_admin_referer('custom-background');
 153                         if ( in_array($_POST['background-attachment'], array('fixed', 'scroll')) )
 154                                 $attachment = $_POST['background-attachment'];
 155                         else
 156                                 $attachment = 'fixed';
 157                         set_theme_mod('background_attachment', $attachment);
 158                 }
 159
 160                 if ( isset($_POST['background-color']) ) {
 161                         check_admin_referer('custom-background');
 162                         $color = preg_replace('/[^0-9a-fA-F]/', '', $_POST['background-color']);
 163                         if ( strlen($color) == 6 || strlen($color) == 3 )
 164                                 set_theme_mod('background_color', $color);
 165                         else
 166                                 set_theme_mod('background_color', '');
 167                 }
 168
 169                 $this->updated = true;
 170         }
 171
 172         /**
 173          * Display the custom background page.
 174          *
 175          * @since 3.0.0
 176          */
 177         public function admin_page() {
 178 ?>
 179 <div class="wrap" id="custom-background">
 180 <h2><?php _e( 'Custom Background' ); ?></h2>
 181
 182 <?php if ( current_user_can( 'customize' ) ) { ?>
 183 <div class="notice notice-info hide-if-no-customize">
 184         <p>
 185                 <?php
 186                 printf(
 187                         __( 'You can now manage and live-preview Custom Backgrounds in the <a href="%1$s">Customizer</a>.' ),
 188                         admin_url( 'customize.php?autofocus[control]=background_image' )
 189                 );
 190                 ?>
 191         </p>
 192 </div>
 193 <?php } ?>
 194
 195 <?php if ( ! empty( $this->updated ) ) { ?>
 196 <div id="message" class="updated">
 197 <p><?php printf( __( 'Background updated. <a href="%s">Visit your site</a> to see how it looks.' ), home_url( '/' ) ); ?></p>
 198 </div>
 199 <?php } ?>
 200
 201 <h3><?php _e( 'Background Image' ); ?></h3>
 202
 203 <table class="form-table">
 204 <tbody>
 205 <tr>
 206 <th scope="row"><?php _e( 'Preview' ); ?></th>
 207 <td>
 208         <?php
 209         if ( $this->admin_image_div_callback ) {
 210                 call_user_func( $this->admin_image_div_callback );
 211         } else {
 212                 $background_styles = '';
 213                 if ( $bgcolor = get_background_color() )
 214                         $background_styles .= 'background-color: #' . $bgcolor . ';';
 215
 216                 $background_image_thumb = get_background_image();
 217                 if ( $background_image_thumb ) {
 218                         $background_image_thumb = esc_url( set_url_scheme( get_theme_mod( 'background_image_thumb', str_replace( '%', '%%', $background_image_thumb ) ) ) );
 219
 220                         // Background-image URL must be single quote, see below.
 221                         $background_styles .= ' background-image: url(\'' . $background_image_thumb . '\');'
 222                                 . ' background-repeat: ' . get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ) . ';'
 223                                 . ' background-position: top ' . get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) );
 224                 }
 225         ?>
 226         <div id="custom-background-image" style="<?php echo $background_styles; ?>"><?php // must be double quote, see above ?>
 227                 <?php if ( $background_image_thumb ) { ?>
 228                 <img class="custom-background-image" src="<?php echo $background_image_thumb; ?>" style="visibility:hidden;" alt="" /><br />
 229                 <img class="custom-background-image" src="<?php echo $background_image_thumb; ?>" style="visibility:hidden;" alt="" />
 230                 <?php } ?>
 231         </div>
 232         <?php } ?>
 233 </td>
 234 </tr>
 235
 236 <?php if ( get_background_image() ) : ?>
 237 <tr>
 238 <th scope="row"><?php _e('Remove Image'); ?></th>
 239 <td>
 240 <form method="post">
 241 <?php wp_nonce_field('custom-background-remove', '_wpnonce-custom-background-remove'); ?>
 242 <?php submit_button( __( 'Remove Background Image' ), 'button', 'remove-background', false ); ?><br/>
 243 <?php _e('This will remove the background image. You will not be able to restore any customizations.') ?>
 244 </form>
 245 </td>
 246 </tr>
 247 <?php endif; ?>
 248
 249 <?php $default_image = get_theme_support( 'custom-background', 'default-image' ); ?>
 250 <?php if ( $default_image && get_background_image() != $default_image ) : ?>
 251 <tr>
 252 <th scope="row"><?php _e('Restore Original Image'); ?></th>
 253 <td>
 254 <form method="post">
 255 <?php wp_nonce_field('custom-background-reset', '_wpnonce-custom-background-reset'); ?>
 256 <?php submit_button( __( 'Restore Original Image' ), 'button', 'reset-background', false ); ?><br/>
 257 <?php _e('This will restore the original background image. You will not be able to restore any customizations.') ?>
 258 </form>
 259 </td>
 260 </tr>
 261 <?php endif; ?>
 262
 263 <tr>
 264 <th scope="row"><?php _e('Select Image'); ?></th>
 265 <td><form enctype="multipart/form-data" id="upload-form" class="wp-upload-form" method="post">
 266         <p>
 267                 <label for="upload"><?php _e( 'Choose an image from your computer:' ); ?></label><br />
 268                 <input type="file" id="upload" name="import" />
 269                 <input type="hidden" name="action" value="save" />
 270                 <?php wp_nonce_field( 'custom-background-upload', '_wpnonce-custom-background-upload' ); ?>
 271                 <?php submit_button( __( 'Upload' ), 'button', 'submit', false ); ?>
 272         </p>
 273         <p>
 274                 <label for="choose-from-library-link"><?php _e( 'Or choose an image from your media library:' ); ?></label><br />
 275                 <button id="choose-from-library-link" class="button"
 276                         data-choose="<?php esc_attr_e( 'Choose a Background Image' ); ?>"
 277                         data-update="<?php esc_attr_e( 'Set as background' ); ?>"><?php _e( 'Choose Image' ); ?></button>
 278         </p>
 279         </form>
 280 </td>
 281 </tr>
 282 </tbody>
 283 </table>
 284
 285 <h3><?php _e('Display Options') ?></h3>
 286 <form method="post">
 287 <table class="form-table">
 288 <tbody>
 289 <?php if ( get_background_image() ) : ?>
 290 <tr>
 291 <th scope="row"><?php _e( 'Position' ); ?></th>
 292 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Position' ); ?></span></legend>
 293 <label>
 294 <input name="background-position-x" type="radio" value="left"<?php checked( 'left', get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) ) ); ?> />
 295 <?php _e('Left') ?>
 296 </label>
 297 <label>
 298 <input name="background-position-x" type="radio" value="center"<?php checked( 'center', get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) ) ); ?> />
 299 <?php _e('Center') ?>
 300 </label>
 301 <label>
 302 <input name="background-position-x" type="radio" value="right"<?php checked( 'right', get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) ) ); ?> />
 303 <?php _e('Right') ?>
 304 </label>
 305 </fieldset></td>
 306 </tr>
 307
 308 <tr>
 309 <th scope="row"><?php _e( 'Repeat' ); ?></th>
 310 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Repeat' ); ?></span></legend>
 311 <label><input type="radio" name="background-repeat" value="no-repeat"<?php checked( 'no-repeat', get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ) ); ?> /> <?php _e('No Repeat'); ?></label>
 312         <label><input type="radio" name="background-repeat" value="repeat"<?php checked( 'repeat', get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ) ); ?> /> <?php _e('Tile'); ?></label>
 313         <label><input type="radio" name="background-repeat" value="repeat-x"<?php checked( 'repeat-x', get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ) ); ?> /> <?php _e('Tile Horizontally'); ?></label>
 314         <label><input type="radio" name="background-repeat" value="repeat-y"<?php checked( 'repeat-y', get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ) ); ?> /> <?php _e('Tile Vertically'); ?></label>
 315 </fieldset></td>
 316 </tr>
 317
 318 <tr>
 319 <th scope="row"><?php _ex( 'Attachment', 'Background Attachment' ); ?></th>
 320 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Attachment' ); ?></span></legend>
 321 <label>
 322 <input name="background-attachment" type="radio" value="scroll" <?php checked( 'scroll', get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) ) ); ?> />
 323 <?php _e( 'Scroll' ); ?>
 324 </label>
 325 <label>
 326 <input name="background-attachment" type="radio" value="fixed" <?php checked( 'fixed', get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) ) ); ?> />
 327 <?php _e( 'Fixed' ); ?>
 328 </label>
 329 </fieldset></td>
 330 </tr>
 331 <?php endif; // get_background_image() ?>
 332 <tr>
 333 <th scope="row"><?php _e( 'Background Color' ); ?></th>
 334 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Color' ); ?></span></legend>
 335 <?php
 336 $default_color = '';
 337 if ( current_theme_supports( 'custom-background', 'default-color' ) )
 338         $default_color = ' data-default-color="#' . esc_attr( get_theme_support( 'custom-background', 'default-color' ) ) . '"';
 339 ?>
 340 <input type="text" name="background-color" id="background-color" value="#<?php echo esc_attr( get_background_color() ); ?>"<?php echo $default_color ?> />
 341 </fieldset></td>
 342 </tr>
 343 </tbody>
 344 </table>
 345
 346 <?php wp_nonce_field('custom-background'); ?>
 347 <?php submit_button( null, 'primary', 'save-background-options' ); ?>
 348 </form>
 349
 350 </div>
 351 <?php
 352         }
 353
 354         /**
 355          * Handle an Image upload for the background image.
 356          *
 357          * @since 3.0.0
 358          */
 359         public function handle_upload() {
 360
 361                 if ( empty($_FILES) )
 362                         return;
 363
 364                 check_admin_referer('custom-background-upload', '_wpnonce-custom-background-upload');
 365                 $overrides = array('test_form' => false);
 366
 367                 $uploaded_file = $_FILES['import'];
 368                 $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'] );
 369                 if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) )
 370                         wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) );
 371
 372                 $file = wp_handle_upload($uploaded_file, $overrides);
 373
 374                 if ( isset($file['error']) )
 375                         wp_die( $file['error'] );
 376
 377                 $url = $file['url'];
 378                 $type = $file['type'];
 379                 $file = $file['file'];
 380                 $filename = basename($file);
 381
 382                 // Construct the object array
 383                 $object = array(
 384                         'post_title' => $filename,
 385                         'post_content' => $url,
 386                         'post_mime_type' => $type,
 387                         'guid' => $url,
 388                         'context' => 'custom-background'
 389                 );
 390
 391                 // Save the data
 392                 $id = wp_insert_attachment($object, $file);
 393
 394                 // Add the meta-data
 395                 wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
 396                 update_post_meta( $id, '_wp_attachment_is_custom_background', get_option('stylesheet' ) );
 397
 398                 set_theme_mod('background_image', esc_url_raw($url));
 399
 400                 $thumbnail = wp_get_attachment_image_src( $id, 'thumbnail' );
 401                 set_theme_mod('background_image_thumb', esc_url_raw( $thumbnail[0] ) );
 402
 403                 /** This action is documented in wp-admin/custom-header.php */
 404                 do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication
 405                 $this->updated = true;
 406         }
 407
 408         /**
 409          * AJAX handler for adding custom background context to an attachment.
 410          *
 411          * Triggered when the user adds a new background image from the
 412          * Media Manager.
 413          *
 414          * @since 4.1.0
 415          */
 416         public function ajax_background_add() {
 417                 check_ajax_referer( 'background-add', 'nonce' );
 418
 419                 if ( ! current_user_can( 'edit_theme_options' ) ) {
 420                         wp_send_json_error();
 421                 }
 422
 423                 $attachment_id = absint( $_POST['attachment_id'] );
 424                 if ( $attachment_id < 1 ) {
 425                         wp_send_json_error();
 426                 }
 427
 428                 update_post_meta( $attachment_id, '_wp_attachment_is_custom_background', get_stylesheet() );
 429
 430                 wp_send_json_success();
 431         }
 432
 433         /**
 434          *
 435          * @since 3.4.0
 436          * @deprecated 3.5.0
 437          */
 438         public function attachment_fields_to_edit( $form_fields ) {
 439                 return $form_fields;
 440         }
 441
 442         /**
 443          *
 444          * @since 3.4.0
 445          * @deprecated 3.5.0
 446          */
 447         public function filter_upload_tabs( $tabs ) {
 448                 return $tabs;
 449         }
 450
 451         /**
 452          *
 453          * @since 3.4.0
 454          * @deprecated 3.5.0
 455          */
 456         public function wp_set_background_image() {
 457                 if ( ! current_user_can('edit_theme_options') || ! isset( $_POST['attachment_id'] ) ) exit;
 458                 $attachment_id = absint($_POST['attachment_id']);
 459                 /** This filter is documented in wp-admin/includes/media.php */
 460                 $sizes = array_keys(apply_filters( 'image_size_names_choose', array('thumbnail' => __('Thumbnail'), 'medium' => __('Medium'), 'large' => __('Large'), 'full' => __('Full Size')) ));
 461                 $size = 'thumbnail';
 462                 if ( in_array( $_POST['size'], $sizes ) )
 463                         $size = esc_attr( $_POST['size'] );
 464
 465                 update_post_meta( $attachment_id, '_wp_attachment_is_custom_background', get_option('stylesheet' ) );
 466                 $url = wp_get_attachment_image_src( $attachment_id, $size );
 467                 $thumbnail = wp_get_attachment_image_src( $attachment_id, 'thumbnail' );
 468                 set_theme_mod( 'background_image', esc_url_raw( $url[0] ) );
 469                 set_theme_mod( 'background_image_thumb', esc_url_raw( $thumbnail[0] ) );
 470                 exit;
 471         }
 472 }