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.
24 public $admin_header_callback;
27 * Callback for header div.
32 public $admin_image_div_callback;
35 * Used to trigger a success message when settings updated and set to true.
44 * Constructor - Register administration header callback.
47 * @param callable $admin_header_callback
48 * @param callable $admin_image_div_callback Optional custom image div output callback.
50 public function __construct($admin_header_callback = '', $admin_image_div_callback = '') {
51 $this->admin_header_callback = $admin_header_callback;
52 $this->admin_image_div_callback = $admin_image_div_callback;
54 add_action( 'admin_menu', array( $this, 'init' ) );
56 add_action( 'wp_ajax_custom-background-add', array( $this, 'ajax_background_add' ) );
58 // Unused since 3.5.0.
59 add_action( 'wp_ajax_set-background-image', array( $this, 'wp_set_background_image' ) );
63 * Set up the hooks for the Custom Background admin page.
67 public function init() {
68 $page = add_theme_page( __( 'Background' ), __( 'Background' ), 'edit_theme_options', 'custom-background', array( $this, 'admin_page' ) );
73 add_action( "load-$page", array( $this, 'admin_load' ) );
74 add_action( "load-$page", array( $this, 'take_action' ), 49 );
75 add_action( "load-$page", array( $this, 'handle_upload' ), 49 );
77 if ( $this->admin_header_callback ) {
78 add_action( "admin_head-$page", $this->admin_header_callback, 51 );
83 * Set up the enqueue for the CSS & JavaScript files.
87 public function admin_load() {
88 get_current_screen()->add_help_tab( array(
90 'title' => __('Overview'),
92 '<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>' .
93 '<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>' .
94 '<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>' .
95 '<p>' . __( 'Don’t forget to click on the Save Changes button when you are finished.' ) . '</p>'
98 get_current_screen()->set_help_sidebar(
99 '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
100 '<p>' . __( '<a href="https://codex.wordpress.org/Appearance_Background_Screen" target="_blank">Documentation on Custom Background</a>' ) . '</p>' .
101 '<p>' . __( '<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>' ) . '</p>'
105 wp_enqueue_script('custom-background');
106 wp_enqueue_style('wp-color-picker');
110 * Execute custom background modification.
114 public function take_action() {
118 if ( isset($_POST['reset-background']) ) {
119 check_admin_referer('custom-background-reset', '_wpnonce-custom-background-reset');
120 remove_theme_mod('background_image');
121 remove_theme_mod('background_image_thumb');
122 $this->updated = true;
126 if ( isset($_POST['remove-background']) ) {
127 // @TODO: Uploaded files are not removed here.
128 check_admin_referer('custom-background-remove', '_wpnonce-custom-background-remove');
129 set_theme_mod('background_image', '');
130 set_theme_mod('background_image_thumb', '');
131 $this->updated = true;
132 wp_safe_redirect( $_POST['_wp_http_referer'] );
136 if ( isset($_POST['background-repeat']) ) {
137 check_admin_referer('custom-background');
138 if ( in_array($_POST['background-repeat'], array('repeat', 'no-repeat', 'repeat-x', 'repeat-y')) )
139 $repeat = $_POST['background-repeat'];
142 set_theme_mod('background_repeat', $repeat);
145 if ( isset($_POST['background-position-x']) ) {
146 check_admin_referer('custom-background');
147 if ( in_array($_POST['background-position-x'], array('center', 'right', 'left')) )
148 $position = $_POST['background-position-x'];
151 set_theme_mod('background_position_x', $position);
154 if ( isset($_POST['background-attachment']) ) {
155 check_admin_referer('custom-background');
156 if ( in_array($_POST['background-attachment'], array('fixed', 'scroll')) )
157 $attachment = $_POST['background-attachment'];
159 $attachment = 'fixed';
160 set_theme_mod('background_attachment', $attachment);
163 if ( isset($_POST['background-color']) ) {
164 check_admin_referer('custom-background');
165 $color = preg_replace('/[^0-9a-fA-F]/', '', $_POST['background-color']);
166 if ( strlen($color) == 6 || strlen($color) == 3 )
167 set_theme_mod('background_color', $color);
169 set_theme_mod('background_color', '');
172 $this->updated = true;
176 * Display the custom background page.
180 public function admin_page() {
182 <div class="wrap" id="custom-background">
183 <h1><?php _e( 'Custom Background' ); ?></h1>
185 <?php if ( current_user_can( 'customize' ) ) { ?>
186 <div class="notice notice-info hide-if-no-customize">
190 __( 'You can now manage and live-preview Custom Backgrounds in the <a href="%1$s">Customizer</a>.' ),
191 admin_url( 'customize.php?autofocus[control]=background_image' )
198 <?php if ( ! empty( $this->updated ) ) { ?>
199 <div id="message" class="updated">
200 <p><?php printf( __( 'Background updated. <a href="%s">Visit your site</a> to see how it looks.' ), home_url( '/' ) ); ?></p>
204 <h3><?php _e( 'Background Image' ); ?></h3>
206 <table class="form-table">
209 <th scope="row"><?php _e( 'Preview' ); ?></th>
212 if ( $this->admin_image_div_callback ) {
213 call_user_func( $this->admin_image_div_callback );
215 $background_styles = '';
216 if ( $bgcolor = get_background_color() )
217 $background_styles .= 'background-color: #' . $bgcolor . ';';
219 $background_image_thumb = get_background_image();
220 if ( $background_image_thumb ) {
221 $background_image_thumb = esc_url( set_url_scheme( get_theme_mod( 'background_image_thumb', str_replace( '%', '%%', $background_image_thumb ) ) ) );
223 // Background-image URL must be single quote, see below.
224 $background_styles .= ' background-image: url(\'' . $background_image_thumb . '\');'
225 . ' background-repeat: ' . get_theme_mod( 'background_repeat', get_theme_support( 'custom-background', 'default-repeat' ) ) . ';'
226 . ' background-position: top ' . get_theme_mod( 'background_position_x', get_theme_support( 'custom-background', 'default-position-x' ) );
229 <div id="custom-background-image" style="<?php echo $background_styles; ?>"><?php // must be double quote, see above ?>
230 <?php if ( $background_image_thumb ) { ?>
231 <img class="custom-background-image" src="<?php echo $background_image_thumb; ?>" style="visibility:hidden;" alt="" /><br />
232 <img class="custom-background-image" src="<?php echo $background_image_thumb; ?>" style="visibility:hidden;" alt="" />
239 <?php if ( get_background_image() ) : ?>
241 <th scope="row"><?php _e('Remove Image'); ?></th>
244 <?php wp_nonce_field('custom-background-remove', '_wpnonce-custom-background-remove'); ?>
245 <?php submit_button( __( 'Remove Background Image' ), 'button', 'remove-background', false ); ?><br/>
246 <?php _e('This will remove the background image. You will not be able to restore any customizations.') ?>
252 <?php $default_image = get_theme_support( 'custom-background', 'default-image' ); ?>
253 <?php if ( $default_image && get_background_image() != $default_image ) : ?>
255 <th scope="row"><?php _e('Restore Original Image'); ?></th>
258 <?php wp_nonce_field('custom-background-reset', '_wpnonce-custom-background-reset'); ?>
259 <?php submit_button( __( 'Restore Original Image' ), 'button', 'reset-background', false ); ?><br/>
260 <?php _e('This will restore the original background image. You will not be able to restore any customizations.') ?>
266 <?php if ( current_user_can( 'upload_files' ) ): ?>
268 <th scope="row"><?php _e('Select Image'); ?></th>
269 <td><form enctype="multipart/form-data" id="upload-form" class="wp-upload-form" method="post">
271 <label for="upload"><?php _e( 'Choose an image from your computer:' ); ?></label><br />
272 <input type="file" id="upload" name="import" />
273 <input type="hidden" name="action" value="save" />
274 <?php wp_nonce_field( 'custom-background-upload', '_wpnonce-custom-background-upload' ); ?>
275 <?php submit_button( __( 'Upload' ), 'button', 'submit', false ); ?>
278 <label for="choose-from-library-link"><?php _e( 'Or choose an image from your media library:' ); ?></label><br />
279 <button id="choose-from-library-link" class="button"
280 data-choose="<?php esc_attr_e( 'Choose a Background Image' ); ?>"
281 data-update="<?php esc_attr_e( 'Set as background' ); ?>"><?php _e( 'Choose Image' ); ?></button>
290 <h3><?php _e('Display Options') ?></h3>
292 <table class="form-table">
294 <?php if ( get_background_image() ) : ?>
296 <th scope="row"><?php _e( 'Position' ); ?></th>
297 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Position' ); ?></span></legend>
299 <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' ) ) ); ?> />
303 <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' ) ) ); ?> />
304 <?php _e('Center') ?>
307 <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' ) ) ); ?> />
314 <th scope="row"><?php _e( 'Repeat' ); ?></th>
315 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Repeat' ); ?></span></legend>
316 <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>
317 <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>
318 <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>
319 <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>
324 <th scope="row"><?php _ex( 'Attachment', 'Background Attachment' ); ?></th>
325 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Attachment' ); ?></span></legend>
327 <input name="background-attachment" type="radio" value="scroll" <?php checked( 'scroll', get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) ) ); ?> />
328 <?php _e( 'Scroll' ); ?>
331 <input name="background-attachment" type="radio" value="fixed" <?php checked( 'fixed', get_theme_mod( 'background_attachment', get_theme_support( 'custom-background', 'default-attachment' ) ) ); ?> />
332 <?php _e( 'Fixed' ); ?>
336 <?php endif; // get_background_image() ?>
338 <th scope="row"><?php _e( 'Background Color' ); ?></th>
339 <td><fieldset><legend class="screen-reader-text"><span><?php _e( 'Background Color' ); ?></span></legend>
342 if ( current_theme_supports( 'custom-background', 'default-color' ) )
343 $default_color = ' data-default-color="#' . esc_attr( get_theme_support( 'custom-background', 'default-color' ) ) . '"';
345 <input type="text" name="background-color" id="background-color" value="#<?php echo esc_attr( get_background_color() ); ?>"<?php echo $default_color ?> />
351 <?php wp_nonce_field('custom-background'); ?>
352 <?php submit_button( null, 'primary', 'save-background-options' ); ?>
360 * Handle an Image upload for the background image.
364 public function handle_upload() {
365 if ( empty($_FILES) )
368 check_admin_referer('custom-background-upload', '_wpnonce-custom-background-upload');
369 $overrides = array('test_form' => false);
371 $uploaded_file = $_FILES['import'];
372 $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'] );
373 if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) )
374 wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) );
376 $file = wp_handle_upload($uploaded_file, $overrides);
378 if ( isset($file['error']) )
379 wp_die( $file['error'] );
382 $type = $file['type'];
383 $file = $file['file'];
384 $filename = basename($file);
386 // Construct the object array
388 'post_title' => $filename,
389 'post_content' => $url,
390 'post_mime_type' => $type,
392 'context' => 'custom-background'
396 $id = wp_insert_attachment($object, $file);
399 wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
400 update_post_meta( $id, '_wp_attachment_is_custom_background', get_option('stylesheet' ) );
402 set_theme_mod('background_image', esc_url_raw($url));
404 $thumbnail = wp_get_attachment_image_src( $id, 'thumbnail' );
405 set_theme_mod('background_image_thumb', esc_url_raw( $thumbnail[0] ) );
407 /** This action is documented in wp-admin/custom-header.php */
408 do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication
409 $this->updated = true;
413 * Ajax handler for adding custom background context to an attachment.
415 * Triggered when the user adds a new background image from the
420 public function ajax_background_add() {
421 check_ajax_referer( 'background-add', 'nonce' );
423 if ( ! current_user_can( 'edit_theme_options' ) ) {
424 wp_send_json_error();
427 $attachment_id = absint( $_POST['attachment_id'] );
428 if ( $attachment_id < 1 ) {
429 wp_send_json_error();
432 update_post_meta( $attachment_id, '_wp_attachment_is_custom_background', get_stylesheet() );
434 wp_send_json_success();
442 * @param array $form_fields
443 * @return array $form_fields
445 public function attachment_fields_to_edit( $form_fields ) {
455 * @return array $tabs
457 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] ) );