3 * The custom background script.
6 * @subpackage Administration
10 * The custom background class.
14 * @subpackage Administration
16 class Custom_Background {
19 * Callback for administration header.
25 private $admin_header_callback;
28 * Callback for header div.
34 private $admin_image_div_callback;
37 * Holds the page menu hook.
46 * Constructor - Register administration header callback.
49 * @param callback $admin_header_callback
50 * @param callback $admin_image_div_callback Optional custom image div output callback.
51 * @return Custom_Background
53 public function __construct($admin_header_callback = '', $admin_image_div_callback = '') {
54 $this->admin_header_callback = $admin_header_callback;
55 $this->admin_image_div_callback = $admin_image_div_callback;
57 add_action( 'admin_menu', array( $this, 'init' ) );
58 add_action( 'wp_ajax_set-background-image', array( $this, 'wp_set_background_image' ) );
62 * Make private properties readable for backwards compatibility.
67 * @param string $name Property name.
68 * @return mixed Property.
70 public function __get( $name ) {
75 * Make private properties settable for backwards compatibility.
80 * @param string $name Property to set.
81 * @param mixed $value Property value.
82 * @return mixed Newly-set property.
84 public function __set( $name, $value ) {
85 return $this->$name = $value;
89 * Make private properties checkable for backwards compatibility.
94 * @param string $name Property to check if set.
95 * @return bool Whether the property is set.
97 public function __isset( $name ) {
98 return isset( $this->$name );
102 * Make private properties un-settable for backwards compatibility.
107 * @param string $name Property to unset.
109 public function __unset( $name ) {
110 unset( $this->$name );
114 * Set up the hooks for the Custom Background admin page.
118 public function init() {
119 if ( ! current_user_can('edit_theme_options') )
122 $this->page = $page = add_theme_page(__('Background'), __('Background'), 'edit_theme_options', 'custom-background', array($this, 'admin_page'));
124 add_action("load-$page", array($this, 'admin_load'));
125 add_action("load-$page", array($this, 'take_action'), 49);
126 add_action("load-$page", array($this, 'handle_upload'), 49);
128 if ( $this->admin_header_callback )
129 add_action("admin_head-$page", $this->admin_header_callback, 51);
133 * Set up the enqueue for the CSS & JavaScript files.
137 public function admin_load() {
138 get_current_screen()->add_help_tab( array(
140 'title' => __('Overview'),
142 '<p>' . __( 'You can customize the look of your site without touching any of your theme’s code by using a custom background. Your background can be an image or a color.' ) . '</p>' .
143 '<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 “Choose Image” 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>' .
144 '<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. “#ff0000” for red, or by choosing a color using the color picker.' ) . '</p>' .
145 '<p>' . __( 'Don’t forget to click on the Save Changes button when you are finished.' ) . '</p>'
148 get_current_screen()->set_help_sidebar(
149 '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
150 '<p>' . __( '<a href="http://codex.wordpress.org/Appearance_Background_Screen" target="_blank">Documentation on Custom Background</a>' ) . '</p>' .
151 '<p>' . __( '<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>' ) . '</p>'
155 wp_enqueue_script('custom-background');
156 wp_enqueue_style('wp-color-picker');
160 * Execute custom background modification.
164 public function take_action() {
169 if ( isset($_POST['reset-background']) ) {
170 check_admin_referer('custom-background-reset', '_wpnonce-custom-background-reset');
171 remove_theme_mod('background_image');
172 remove_theme_mod('background_image_thumb');
173 $this->updated = true;
177 if ( isset($_POST['remove-background']) ) {
178 // @TODO: Uploaded files are not removed here.
179 check_admin_referer('custom-background-remove', '_wpnonce-custom-background-remove');
180 set_theme_mod('background_image', '');
181 set_theme_mod('background_image_thumb', '');
182 $this->updated = true;
183 wp_safe_redirect( $_POST['_wp_http_referer'] );
187 if ( isset($_POST['background-repeat']) ) {
188 check_admin_referer('custom-background');
189 if ( in_array($_POST['background-repeat'], array('repeat', 'no-repeat', 'repeat-x', 'repeat-y')) )
190 $repeat = $_POST['background-repeat'];
193 set_theme_mod('background_repeat', $repeat);
196 if ( isset($_POST['background-position-x']) ) {
197 check_admin_referer('custom-background');
198 if ( in_array($_POST['background-position-x'], array('center', 'right', 'left')) )
199 $position = $_POST['background-position-x'];
202 set_theme_mod('background_position_x', $position);
205 if ( isset($_POST['background-attachment']) ) {
206 check_admin_referer('custom-background');
207 if ( in_array($_POST['background-attachment'], array('fixed', 'scroll')) )
208 $attachment = $_POST['background-attachment'];
210 $attachment = 'fixed';
211 set_theme_mod('background_attachment', $attachment);
214 if ( isset($_POST['background-color']) ) {
215 check_admin_referer('custom-background');
216 $color = preg_replace('/[^0-9a-fA-F]/', '', $_POST['background-color']);
217 if ( strlen($color) == 6 || strlen($color) == 3 )
218 set_theme_mod('background_color', $color);
220 set_theme_mod('background_color', '');
223 $this->updated = true;
227 * Display the custom background page.
231 public function admin_page() {
233 <div class="wrap" id="custom-background">
234 <h2><?php _e( 'Custom Background' ); ?></h2>
236 <?php if ( ! empty( $this->updated ) ) { ?>
237 <div id="message" class="updated">
238 <p><?php printf( __( 'Background updated. <a href="%s">Visit your site</a> to see how it looks.' ), home_url( '/' ) ); ?></p>
242 <h3><?php _e( 'Background Image' ); ?></h3>
244 <table class="form-table">
247 <th scope="row"><?php _e( 'Preview' ); ?></th>
250 if ( $this->admin_image_div_callback ) {
251 call_user_func( $this->admin_image_div_callback );
253 $background_styles = '';
254 if ( $bgcolor = get_background_color() )
255 $background_styles .= 'background-color: #' . $bgcolor . ';';
257 if ( get_background_image() ) {
258 $background_image_thumb = esc_url( set_url_scheme( get_theme_mod( 'background_image_thumb', str_replace( '%', '%%', get_background_image() ) ) ) );
260 // Background-image URL must be single quote, see below.
261 $background_styles .= ' background-image: url(\'' . $background_image_thumb . '\');'
262 . ' background-repeat: ' . get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ) . ';'
263 . ' background-position: top ' . get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) );
266 <div id="custom-background-image" style="<?php echo $background_styles; ?>"><?php // must be double quote, see above ?>
267 <?php if ( get_background_image() ) { ?>
268 <img class="custom-background-image" src="<?php echo $background_image_thumb; ?>" style="visibility:hidden;" alt="" /><br />
269 <img class="custom-background-image" src="<?php echo $background_image_thumb; ?>" style="visibility:hidden;" alt="" />
276 <?php if ( get_background_image() ) : ?>
278 <th scope="row"><?php _e('Remove Image'); ?></th>
280 <form method="post" action="">
281 <?php wp_nonce_field('custom-background-remove', '_wpnonce-custom-background-remove'); ?>
282 <?php submit_button( __( 'Remove Background Image' ), 'button', 'remove-background', false ); ?><br/>
283 <?php _e('This will remove the background image. You will not be able to restore any customizations.') ?>
289 <?php $default_image = get_theme_support( 'custom-background', 'default-image' ); ?>
290 <?php if ( $default_image && get_background_image() != $default_image ) : ?>
292 <th scope="row"><?php _e('Restore Original Image'); ?></th>
294 <form method="post" action="">
295 <?php wp_nonce_field('custom-background-reset', '_wpnonce-custom-background-reset'); ?>
296 <?php submit_button( __( 'Restore Original Image' ), 'button', 'reset-background', false ); ?><br/>
297 <?php _e('This will restore the original background image. You will not be able to restore any customizations.') ?>
304 <th scope="row"><?php _e('Select Image'); ?></th>
305 <td><form enctype="multipart/form-data" id="upload-form" class="wp-upload-form" method="post" action="">
307 <label for="upload"><?php _e( 'Choose an image from your computer:' ); ?></label><br />
308 <input type="file" id="upload" name="import" />
309 <input type="hidden" name="action" value="save" />
310 <?php wp_nonce_field( 'custom-background-upload', '_wpnonce-custom-background-upload' ); ?>
311 <?php submit_button( __( 'Upload' ), 'button', 'submit', false ); ?>
314 <label for="choose-from-library-link"><?php _e( 'Or choose an image from your media library:' ); ?></label><br />
315 <a id="choose-from-library-link" class="button"
316 data-choose="<?php esc_attr_e( 'Choose a Background Image' ); ?>"
317 data-update="<?php esc_attr_e( 'Set as background' ); ?>"><?php _e( 'Choose Image' ); ?></a>
325 <h3><?php _e('Display Options') ?></h3>
326 <form method="post" action="">
327 <table class="form-table">
329 <?php if ( get_background_image() ) : ?>
331 <th scope="row"><?php _e( 'Position' ); ?></th>
332 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Position' ); ?></span></legend>
334 <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' ) ) ); ?> />
338 <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' ) ) ); ?> />
339 <?php _e('Center') ?>
342 <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' ) ) ); ?> />
349 <th scope="row"><?php _e( 'Repeat' ); ?></th>
350 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Repeat' ); ?></span></legend>
351 <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>
352 <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>
353 <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>
354 <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>
359 <th scope="row"><?php _ex( 'Attachment', 'Background Attachment' ); ?></th>
360 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Attachment' ); ?></span></legend>
362 <input name="background-attachment" type="radio" value="scroll" <?php checked( 'scroll', get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) ) ); ?> />
363 <?php _e( 'Scroll' ); ?>
366 <input name="background-attachment" type="radio" value="fixed" <?php checked( 'fixed', get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) ) ); ?> />
367 <?php _e( 'Fixed' ); ?>
371 <?php endif; // get_background_image() ?>
373 <th scope="row"><?php _e( 'Background Color' ); ?></th>
374 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Color' ); ?></span></legend>
377 if ( current_theme_supports( 'custom-background', 'default-color' ) )
378 $default_color = ' data-default-color="#' . esc_attr( get_theme_support( 'custom-background', 'default-color' ) ) . '"';
380 <input type="text" name="background-color" id="background-color" value="#<?php echo esc_attr( get_background_color() ); ?>"<?php echo $default_color ?> />
386 <?php wp_nonce_field('custom-background'); ?>
387 <?php submit_button( null, 'primary', 'save-background-options' ); ?>
395 * Handle an Image upload for the background image.
399 public function handle_upload() {
401 if ( empty($_FILES) )
404 check_admin_referer('custom-background-upload', '_wpnonce-custom-background-upload');
405 $overrides = array('test_form' => false);
407 $uploaded_file = $_FILES['import'];
408 $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'], false );
409 if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) )
410 wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) );
412 $file = wp_handle_upload($uploaded_file, $overrides);
414 if ( isset($file['error']) )
415 wp_die( $file['error'] );
418 $type = $file['type'];
419 $file = $file['file'];
420 $filename = basename($file);
422 // Construct the object array
424 'post_title' => $filename,
425 'post_content' => $url,
426 'post_mime_type' => $type,
428 'context' => 'custom-background'
432 $id = wp_insert_attachment($object, $file);
435 wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
436 update_post_meta( $id, '_wp_attachment_is_custom_background', get_option('stylesheet' ) );
438 set_theme_mod('background_image', esc_url_raw($url));
440 $thumbnail = wp_get_attachment_image_src( $id, 'thumbnail' );
441 set_theme_mod('background_image_thumb', esc_url_raw( $thumbnail[0] ) );
443 /** This action is documented in wp-admin/custom-header.php */
444 do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication
445 $this->updated = true;
449 * Unused since 3.5.0.
453 public function attachment_fields_to_edit( $form_fields ) {
458 * Unused since 3.5.0.
462 public function filter_upload_tabs( $tabs ) {
466 public function wp_set_background_image() {
467 if ( ! current_user_can('edit_theme_options') || ! isset( $_POST['attachment_id'] ) ) exit;
468 $attachment_id = absint($_POST['attachment_id']);
469 /** This filter is documented in wp-admin/includes/media.php */
470 $sizes = array_keys(apply_filters( 'image_size_names_choose', array('thumbnail' => __('Thumbnail'), 'medium' => __('Medium'), 'large' => __('Large'), 'full' => __('Full Size')) ));
472 if ( in_array( $_POST['size'], $sizes ) )
473 $size = esc_attr( $_POST['size'] );
475 update_post_meta( $attachment_id, '_wp_attachment_is_custom_background', get_option('stylesheet' ) );
476 $url = wp_get_attachment_image_src( $attachment_id, $size );
477 $thumbnail = wp_get_attachment_image_src( $attachment_id, 'thumbnail' );
478 set_theme_mod( 'background_image', esc_url_raw( $url[0] ) );
479 set_theme_mod( 'background_image_thumb', esc_url_raw( $thumbnail[0] ) );