3 * The custom header image script.
6 * @subpackage Administration
10 * The custom header image class.
14 * @subpackage Administration
16 class Custom_Image_Header {
19 * Callback for administration header.
25 var $admin_header_callback;
28 * Callback for header div.
34 var $admin_image_div_callback;
37 * Holds default headers.
43 var $default_headers = array();
46 * Holds custom headers uploaded by the user.
52 var $uploaded_headers = array();
55 * Holds the page menu hook.
64 * Constructor - Register administration header callback.
67 * @param callback $admin_header_callback
68 * @param callback $admin_image_div_callback Optional custom image div output callback.
69 * @return Custom_Image_Header
71 function __construct($admin_header_callback, $admin_image_div_callback = '') {
72 $this->admin_header_callback = $admin_header_callback;
73 $this->admin_image_div_callback = $admin_image_div_callback;
75 add_action( 'admin_menu', array( $this, 'init' ) );
77 add_action( 'customize_save_after', array( $this, 'customize_set_last_used' ) );
78 add_action( 'wp_ajax_custom-header-crop', array( $this, 'ajax_header_crop' ) );
79 add_action( 'wp_ajax_custom-header-add', array( $this, 'ajax_header_add' ) );
80 add_action( 'wp_ajax_custom-header-remove', array( $this, 'ajax_header_remove' ) );
84 * Set up the hooks for the Custom Header admin page.
89 if ( ! current_user_can('edit_theme_options') )
92 $this->page = $page = add_theme_page(__('Header'), __('Header'), 'edit_theme_options', 'custom-header', array($this, 'admin_page'));
94 add_action("admin_print_scripts-$page", array($this, 'js_includes'));
95 add_action("admin_print_styles-$page", array($this, 'css_includes'));
96 add_action("admin_head-$page", array($this, 'help') );
97 add_action("admin_head-$page", array($this, 'take_action'), 50);
98 add_action("admin_head-$page", array($this, 'js'), 50);
99 if ( $this->admin_header_callback )
100 add_action("admin_head-$page", $this->admin_header_callback, 51);
105 * Adds contextual help.
110 get_current_screen()->add_help_tab( array(
112 'title' => __('Overview'),
114 '<p>' . __( 'This screen is used to customize the header section of your theme.') . '</p>' .
115 '<p>' . __( 'You can choose from the theme’s default header images, or use one of your own. You can also customize how your Site Title and Tagline are displayed.') . '<p>'
118 get_current_screen()->add_help_tab( array(
119 'id' => 'set-header-image',
120 'title' => __('Header Image'),
122 '<p>' . __( 'You can set a custom image header for your site. Simply upload the image and crop it, and the new header will go live immediately. Alternatively, you can use an image that has already been uploaded to your Media Library by clicking the “Choose Image” button.' ) . '</p>' .
123 '<p>' . __( 'Some themes come with additional header images bundled. If you see multiple images displayed, select the one you’d like and click the “Save Changes” button.' ) . '</p>' .
124 '<p>' . __( 'If your theme has more than one default header image, or you have uploaded more than one custom header image, you have the option of having WordPress display a randomly different image on each page of your site. Click the “Random” radio button next to the Uploaded Images or Default Images section to enable this feature.') . '</p>' .
125 '<p>' . __( 'If you don’t want a header image to be displayed on your site at all, click the “Remove Header Image” button at the bottom of the Header Image section of this page. If you want to re-enable the header image later, you just have to select one of the other image options and click “Save Changes”.') . '</p>'
128 get_current_screen()->add_help_tab( array(
129 'id' => 'set-header-text',
130 'title' => __('Header Text'),
132 '<p>' . sprintf( __( 'For most themes, the header text is your Site Title and Tagline, as defined in the <a href="%1$s">General Settings</a> section.' ), admin_url( 'options-general.php' ) ) . '<p>' .
133 '<p>' . __( 'In the Header Text section of this page, you can choose whether to display this text or hide it. You can also choose a color for the text 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>' .
134 '<p>' . __( 'Don’t forget to click “Save Changes” when you’re done!') . '</p>'
137 get_current_screen()->set_help_sidebar(
138 '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
139 '<p>' . __( '<a href="http://codex.wordpress.org/Appearance_Header_Screen" target="_blank">Documentation on Custom Header</a>' ) . '</p>' .
140 '<p>' . __( '<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>' ) . '</p>'
145 * Get the current step.
149 * @return int Current step
152 if ( ! isset( $_GET['step'] ) )
155 $step = (int) $_GET['step'];
156 if ( $step < 1 || 3 < $step ||
157 ( 2 == $step && ! wp_verify_nonce( $_REQUEST['_wpnonce-custom-header-upload'], 'custom-header-upload' ) ) ||
158 ( 3 == $step && ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'custom-header-crop-image' ) )
166 * Set up the enqueue for the JavaScript files.
170 function js_includes() {
171 $step = $this->step();
173 if ( ( 1 == $step || 3 == $step ) ) {
175 wp_enqueue_script( 'custom-header' );
176 if ( current_theme_supports( 'custom-header', 'header-text' ) )
177 wp_enqueue_script( 'wp-color-picker' );
178 } elseif ( 2 == $step ) {
179 wp_enqueue_script('imgareaselect');
184 * Set up the enqueue for the CSS files
188 function css_includes() {
189 $step = $this->step();
191 if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) )
192 wp_enqueue_style( 'wp-color-picker' );
193 elseif ( 2 == $step )
194 wp_enqueue_style('imgareaselect');
198 * Execute custom header modification.
202 function take_action() {
203 if ( ! current_user_can('edit_theme_options') )
206 if ( empty( $_POST ) )
209 $this->updated = true;
211 if ( isset( $_POST['resetheader'] ) ) {
212 check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' );
213 $this->reset_header_image();
217 if ( isset( $_POST['removeheader'] ) ) {
218 check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' );
219 $this->remove_header_image();
223 if ( isset( $_POST['text-color'] ) && ! isset( $_POST['display-header-text'] ) ) {
224 check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' );
225 set_theme_mod( 'header_textcolor', 'blank' );
226 } elseif ( isset( $_POST['text-color'] ) ) {
227 check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' );
228 $_POST['text-color'] = str_replace( '#', '', $_POST['text-color'] );
229 $color = preg_replace('/[^0-9a-fA-F]/', '', $_POST['text-color']);
230 if ( strlen($color) == 6 || strlen($color) == 3 )
231 set_theme_mod('header_textcolor', $color);
233 set_theme_mod( 'header_textcolor', 'blank' );
236 if ( isset( $_POST['default-header'] ) ) {
237 check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' );
238 $this->set_header_image( $_POST['default-header'] );
244 * Process the default headers
248 function process_default_headers() {
249 global $_wp_default_headers;
251 if ( !empty($this->headers) )
254 if ( !isset($_wp_default_headers) )
257 if ( ! empty( $this->default_headers ) ) {
261 $this->default_headers = $_wp_default_headers;
262 $template_directory_uri = get_template_directory_uri();
263 $stylesheet_directory_uri = get_stylesheet_directory_uri();
264 foreach ( array_keys($this->default_headers) as $header ) {
265 $this->default_headers[$header]['url'] = sprintf( $this->default_headers[$header]['url'], $template_directory_uri, $stylesheet_directory_uri );
266 $this->default_headers[$header]['thumbnail_url'] = sprintf( $this->default_headers[$header]['thumbnail_url'], $template_directory_uri, $stylesheet_directory_uri );
271 * Display UI for selecting one of several default headers.
273 * Show the random image option if this theme has multiple header images.
274 * Random image option is on by default if no header has been set.
278 function show_header_selector( $type = 'default' ) {
279 if ( 'default' == $type ) {
280 $headers = $this->default_headers;
282 $headers = get_uploaded_header_images();
286 if ( 1 < count( $headers ) ) {
287 echo '<div class="random-header">';
288 echo '<label><input name="default-header" type="radio" value="random-' . $type . '-image"' . checked( is_random_header_image( $type ), true, false ) . ' />';
289 echo __( '<strong>Random:</strong> Show a different image on each page.' );
294 echo '<div class="available-headers">';
295 foreach ( $headers as $header_key => $header ) {
296 $header_thumbnail = $header['thumbnail_url'];
297 $header_url = $header['url'];
298 $header_desc = empty( $header['description'] ) ? '' : $header['description'];
299 echo '<div class="default-header">';
300 echo '<label><input name="default-header" type="radio" value="' . esc_attr( $header_key ) . '" ' . checked( $header_url, get_theme_mod( 'header_image' ), false ) . ' />';
302 if ( !empty( $header['attachment_id'] ) )
303 $width = ' width="230"';
304 echo '<img src="' . set_url_scheme( $header_thumbnail ) . '" alt="' . esc_attr( $header_desc ) .'" title="' . esc_attr( $header_desc ) . '"' . $width . ' /></label>';
307 echo '<div class="clear"></div></div>';
311 * Execute Javascript depending on step.
316 $step = $this->step();
317 if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) )
319 elseif ( 2 == $step )
324 * Display Javascript based on Step 1 and 3.
329 <script type="text/javascript">
332 var default_color = '#<?php echo get_theme_support( 'custom-header', 'default-text-color' ); ?>',
335 function pickColor(color) {
336 $('#name').css('color', color);
337 $('#desc').css('color', color);
338 $('#text-color').val(color);
341 function toggle_text() {
342 var checked = $('#display-header-text').prop('checked'),
344 header_text_fields.toggle( checked );
347 text_color = $('#text-color');
348 if ( '' == text_color.val().replace('#', '') ) {
349 text_color.val( default_color );
350 pickColor( default_color );
352 pickColor( text_color.val() );
356 $(document).ready(function() {
357 var text_color = $('#text-color');
358 header_text_fields = $('.displaying-header-text');
359 text_color.wpColorPicker({
360 change: function( event, ui ) {
361 pickColor( text_color.wpColorPicker('color') );
367 $('#display-header-text').click( toggle_text );
368 <?php if ( ! display_header_text() ) : ?>
379 * Display Javascript based on Step 2.
384 <script type="text/javascript">
386 function onEndCrop( coords ) {
387 jQuery( '#x1' ).val(coords.x);
388 jQuery( '#y1' ).val(coords.y);
389 jQuery( '#width' ).val(coords.w);
390 jQuery( '#height' ).val(coords.h);
393 jQuery(document).ready(function() {
394 var xinit = <?php echo absint( get_theme_support( 'custom-header', 'width' ) ); ?>;
395 var yinit = <?php echo absint( get_theme_support( 'custom-header', 'height' ) ); ?>;
396 var ratio = xinit / yinit;
397 var ximg = jQuery('img#upload').width();
398 var yimg = jQuery('img#upload').height();
400 if ( yimg < yinit || ximg < xinit ) {
401 if ( ximg / yimg > ratio ) {
403 xinit = yinit * ratio;
406 yinit = xinit / ratio;
410 jQuery('img#upload').imgAreaSelect({
419 if ( ! current_theme_supports( 'custom-header', 'flex-height' ) && ! current_theme_supports( 'custom-header', 'flex-width' ) ) {
421 aspectRatio: xinit + ':' + yinit,
424 if ( ! current_theme_supports( 'custom-header', 'flex-height' ) ) {
426 maxHeight: <?php echo get_theme_support( 'custom-header', 'height' ); ?>,
429 if ( ! current_theme_supports( 'custom-header', 'flex-width' ) ) {
431 maxWidth: <?php echo get_theme_support( 'custom-header', 'width' ); ?>,
435 onInit: function () {
436 jQuery('#width').val(xinit);
437 jQuery('#height').val(yinit);
439 onSelectChange: function(img, c) {
440 jQuery('#x1').val(c.x1);
441 jQuery('#y1').val(c.y1);
442 jQuery('#width').val(c.width);
443 jQuery('#height').val(c.height);
453 * Display first step of custom header image page.
458 $this->process_default_headers();
462 <h2><?php _e( 'Custom Header' ); ?></h2>
464 <?php if ( ! empty( $this->updated ) ) { ?>
465 <div id="message" class="updated">
466 <p><?php printf( __( 'Header updated. <a href="%s">Visit your site</a> to see how it looks.' ), home_url( '/' ) ); ?></p>
470 <h3><?php _e( 'Header Image' ); ?></h3>
472 <table class="form-table">
475 <?php if ( get_custom_header() || display_header_text() ) : ?>
477 <th scope="row"><?php _e( 'Preview' ); ?></th>
480 if ( $this->admin_image_div_callback ) {
481 call_user_func( $this->admin_image_div_callback );
483 $custom_header = get_custom_header();
484 $header_image_style = 'background-image:url(' . esc_url( get_header_image() ) . ');';
485 if ( $custom_header->width )
486 $header_image_style .= 'max-width:' . $custom_header->width . 'px;';
487 if ( $custom_header->height )
488 $header_image_style .= 'height:' . $custom_header->height . 'px;';
490 <div id="headimg" style="<?php echo $header_image_style; ?>">
492 if ( display_header_text() )
493 $style = ' style="color:#' . get_header_textcolor() . ';"';
495 $style = ' style="display:none;"';
497 <h1><a id="name" class="displaying-header-text" <?php echo $style; ?> onclick="return false;" href="<?php bloginfo('url'); ?>"><?php bloginfo( 'name' ); ?></a></h1>
498 <div id="desc" class="displaying-header-text" <?php echo $style; ?>><?php bloginfo( 'description' ); ?></div>
505 <?php if ( current_theme_supports( 'custom-header', 'uploads' ) ) : ?>
507 <th scope="row"><?php _e( 'Select Image' ); ?></th>
509 <p><?php _e( 'You can select an image to be shown at the top of your site by uploading from your computer or choosing from your media library. After selecting an image you will be able to crop it.' ); ?><br />
511 if ( ! current_theme_supports( 'custom-header', 'flex-height' ) && ! current_theme_supports( 'custom-header', 'flex-width' ) ) {
512 printf( __( 'Images of exactly <strong>%1$d × %2$d pixels</strong> will be used as-is.' ) . '<br />', get_theme_support( 'custom-header', 'width' ), get_theme_support( 'custom-header', 'height' ) );
513 } elseif ( current_theme_supports( 'custom-header', 'flex-height' ) ) {
514 if ( ! current_theme_supports( 'custom-header', 'flex-width' ) )
515 printf( __( 'Images should be at least <strong>%1$d pixels</strong> wide.' ) . ' ', get_theme_support( 'custom-header', 'width' ) );
516 } elseif ( current_theme_supports( 'custom-header', 'flex-width' ) ) {
517 if ( ! current_theme_supports( 'custom-header', 'flex-height' ) )
518 printf( __( 'Images should be at least <strong>%1$d pixels</strong> tall.' ) . ' ', get_theme_support( 'custom-header', 'height' ) );
520 if ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) {
521 if ( current_theme_supports( 'custom-header', 'width' ) )
522 printf( __( 'Suggested width is <strong>%1$d pixels</strong>.' ) . ' ', get_theme_support( 'custom-header', 'width' ) );
523 if ( current_theme_supports( 'custom-header', 'height' ) )
524 printf( __( 'Suggested height is <strong>%1$d pixels</strong>.' ) . ' ', get_theme_support( 'custom-header', 'height' ) );
527 <form enctype="multipart/form-data" id="upload-form" class="wp-upload-form" method="post" action="<?php echo esc_url( add_query_arg( 'step', 2 ) ) ?>">
529 <label for="upload"><?php _e( 'Choose an image from your computer:' ); ?></label><br />
530 <input type="file" id="upload" name="import" />
531 <input type="hidden" name="action" value="save" />
532 <?php wp_nonce_field( 'custom-header-upload', '_wpnonce-custom-header-upload' ); ?>
533 <?php submit_button( __( 'Upload' ), 'button', 'submit', false ); ?>
536 $modal_update_href = esc_url( add_query_arg( array(
537 'page' => 'custom-header',
539 '_wpnonce-custom-header-upload' => wp_create_nonce('custom-header-upload'),
540 ), admin_url('themes.php') ) );
543 <label for="choose-from-library-link"><?php _e( 'Or choose an image from your media library:' ); ?></label><br />
544 <a id="choose-from-library-link" class="button"
545 data-update-link="<?php echo esc_attr( $modal_update_href ); ?>"
546 data-choose="<?php esc_attr_e( 'Choose a Custom Header' ); ?>"
547 data-update="<?php esc_attr_e( 'Set as header' ); ?>"><?php _e( 'Choose Image' ); ?></a>
556 <form method="post" action="<?php echo esc_url( add_query_arg( 'step', 1 ) ) ?>">
557 <table class="form-table">
559 <?php if ( get_uploaded_header_images() ) : ?>
561 <th scope="row"><?php _e( 'Uploaded Images' ); ?></th>
563 <p><?php _e( 'You can choose one of your previously uploaded headers, or show a random one.' ) ?></p>
565 $this->show_header_selector( 'uploaded' );
570 if ( ! empty( $this->default_headers ) ) : ?>
572 <th scope="row"><?php _e( 'Default Images' ); ?></th>
574 <?php if ( current_theme_supports( 'custom-header', 'uploads' ) ) : ?>
575 <p><?php _e( 'If you don‘t want to upload your own image, you can use one of these cool headers, or show a random one.' ) ?></p>
577 <p><?php _e( 'You can use one of these cool headers or show a random one on each page.' ) ?></p>
580 $this->show_header_selector( 'default' );
585 if ( get_header_image() ) : ?>
587 <th scope="row"><?php _e( 'Remove Image' ); ?></th>
589 <p><?php _e( 'This will remove the header image. You will not be able to restore any customizations.' ) ?></p>
590 <?php submit_button( __( 'Remove Header Image' ), 'button', 'removeheader', false ); ?>
595 $default_image = get_theme_support( 'custom-header', 'default-image' );
596 if ( $default_image && get_header_image() != $default_image ) : ?>
598 <th scope="row"><?php _e( 'Reset Image' ); ?></th>
600 <p><?php _e( 'This will restore the original header image. You will not be able to restore any customizations.' ) ?></p>
601 <?php submit_button( __( 'Restore Original Header Image' ), 'button', 'resetheader', false ); ?>
608 <?php if ( current_theme_supports( 'custom-header', 'header-text' ) ) : ?>
610 <h3><?php _e( 'Header Text' ); ?></h3>
612 <table class="form-table">
615 <th scope="row"><?php _e( 'Header Text' ); ?></th>
618 <label><input type="checkbox" name="display-header-text" id="display-header-text"<?php checked( display_header_text() ); ?> /> <?php _e( 'Show header text with your image.' ); ?></label>
623 <tr class="displaying-header-text">
624 <th scope="row"><?php _e( 'Text Color' ); ?></th>
628 $header_textcolor = display_header_text() ? get_header_textcolor() : get_theme_support( 'custom-header', 'default-text-color' );
630 if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) {
631 $default_color = '#' . get_theme_support( 'custom-header', 'default-text-color' );
632 $default_color_attr = ' data-default-color="' . esc_attr( $default_color ) . '"';
633 echo '<input type="text" name="text-color" id="text-color" value="#' . esc_attr( $header_textcolor ) . '"' . $default_color_attr . ' />';
634 if ( $default_color )
635 echo ' <span class="description hide-if-js">' . sprintf( _x( 'Default: %s', 'color' ), $default_color ) . '</span>';
646 * Fires just before the submit button in the custom header options form.
650 do_action( 'custom_header_options' );
652 wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
654 <?php submit_button( null, 'primary', 'save-header-options' ); ?>
661 * Display second step of custom header image page.
666 check_admin_referer('custom-header-upload', '_wpnonce-custom-header-upload');
667 if ( ! current_theme_supports( 'custom-header', 'uploads' ) )
668 wp_die( __( 'Cheatin’ uh?' ) );
670 if ( empty( $_POST ) && isset( $_GET['file'] ) ) {
671 $attachment_id = absint( $_GET['file'] );
672 $file = get_attached_file( $attachment_id, true );
673 $url = wp_get_attachment_image_src( $attachment_id, 'full');
675 } elseif ( isset( $_POST ) ) {
676 extract($this->step_2_manage_upload());
679 if ( file_exists( $file ) ) {
680 list( $width, $height, $type, $attr ) = getimagesize( $file );
682 $data = wp_get_attachment_metadata( $attachment_id );
683 $height = isset( $data[ 'height' ] ) ? $data[ 'height' ] : 0;
684 $width = isset( $data[ 'width' ] ) ? $data[ 'width' ] : 0;
689 // For flex, limit size of image displayed to 1500px unless theme says otherwise
690 if ( current_theme_supports( 'custom-header', 'flex-width' ) )
693 if ( current_theme_supports( 'custom-header', 'max-width' ) )
694 $max_width = max( $max_width, get_theme_support( 'custom-header', 'max-width' ) );
695 $max_width = max( $max_width, get_theme_support( 'custom-header', 'width' ) );
697 // If flexible height isn't supported and the image is the exact right size
698 if ( ! current_theme_supports( 'custom-header', 'flex-height' ) && ! current_theme_supports( 'custom-header', 'flex-width' )
699 && $width == get_theme_support( 'custom-header', 'width' ) && $height == get_theme_support( 'custom-header', 'height' ) )
702 if ( file_exists( $file ) )
703 wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );
705 $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );
708 * Fires after the header image is set or an error is returned.
712 * @param string $file Path to the file.
713 * @param int $attachment_id Attachment ID.
715 do_action( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication
717 return $this->finished();
718 } elseif ( $width > $max_width ) {
719 $oitar = $width / $max_width;
720 $image = wp_crop_image($attachment_id, 0, 0, $width, $height, $max_width, $height / $oitar, false, str_replace(basename($file), 'midsize-'.basename($file), $file));
721 if ( ! $image || is_wp_error( $image ) )
722 wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) );
724 /** This filter is documented in wp-admin/custom-header.php */
725 $image = apply_filters( 'wp_create_file_in_uploads', $image, $attachment_id ); // For replication
727 $url = str_replace(basename($url), basename($image), $url);
728 $width = $width / $oitar;
729 $height = $height / $oitar;
736 <h2><?php _e( 'Crop Header Image' ); ?></h2>
738 <form method="post" action="<?php echo esc_url(add_query_arg('step', 3)); ?>">
739 <p class="hide-if-no-js"><?php _e('Choose the part of the image you want to use as your header.'); ?></p>
740 <p class="hide-if-js"><strong><?php _e( 'You need Javascript to choose a part of the image.'); ?></strong></p>
742 <div id="crop_image" style="position: relative">
743 <img src="<?php echo esc_url( $url ); ?>" id="upload" width="<?php echo $width; ?>" height="<?php echo $height; ?>" />
746 <input type="hidden" name="x1" id="x1" value="0"/>
747 <input type="hidden" name="y1" id="y1" value="0"/>
748 <input type="hidden" name="width" id="width" value="<?php echo esc_attr( $width ); ?>"/>
749 <input type="hidden" name="height" id="height" value="<?php echo esc_attr( $height ); ?>"/>
750 <input type="hidden" name="attachment_id" id="attachment_id" value="<?php echo esc_attr( $attachment_id ); ?>" />
751 <input type="hidden" name="oitar" id="oitar" value="<?php echo esc_attr( $oitar ); ?>" />
752 <?php if ( empty( $_POST ) && isset( $_GET['file'] ) ) { ?>
753 <input type="hidden" name="create-new-attachment" value="true" />
755 <?php wp_nonce_field( 'custom-header-crop-image' ) ?>
758 <?php submit_button( __( 'Crop and Publish' ), 'primary', 'submit', false ); ?>
760 if ( isset( $oitar ) && 1 == $oitar && ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) )
761 submit_button( __( 'Skip Cropping, Publish Image as Is' ), 'secondary', 'skip-cropping', false );
771 * Upload the file to be cropped in the second step.
775 function step_2_manage_upload() {
776 $overrides = array('test_form' => false);
778 $uploaded_file = $_FILES['import'];
779 $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'], false );
780 if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) )
781 wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) );
783 $file = wp_handle_upload($uploaded_file, $overrides);
785 if ( isset($file['error']) )
786 wp_die( $file['error'], __( 'Image Upload Error' ) );
789 $type = $file['type'];
790 $file = $file['file'];
791 $filename = basename($file);
793 // Construct the object array
795 'post_title' => $filename,
796 'post_content' => $url,
797 'post_mime_type' => $type,
799 'context' => 'custom-header'
803 $attachment_id = wp_insert_attachment( $object, $file );
804 return compact( 'attachment_id', 'file', 'filename', 'url', 'type' );
808 * Display third step of custom header image page.
813 check_admin_referer( 'custom-header-crop-image' );
815 if ( ! current_theme_supports( 'custom-header', 'uploads' ) )
816 wp_die( __( 'Cheatin’ uh?' ) );
818 if ( ! empty( $_POST['skip-cropping'] ) && ! ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) )
819 wp_die( __( 'Cheatin’ uh?' ) );
821 if ( $_POST['oitar'] > 1 ) {
822 $_POST['x1'] = $_POST['x1'] * $_POST['oitar'];
823 $_POST['y1'] = $_POST['y1'] * $_POST['oitar'];
824 $_POST['width'] = $_POST['width'] * $_POST['oitar'];
825 $_POST['height'] = $_POST['height'] * $_POST['oitar'];
828 $attachment_id = absint( $_POST['attachment_id'] );
829 $original = get_attached_file($attachment_id);
831 $dimensions = $this->get_header_dimensions( array(
832 'height' => $_POST['height'],
833 'width' => $_POST['width'],
835 $height = $dimensions['dst_height'];
836 $width = $dimensions['dst_width'];
838 if ( empty( $_POST['skip-cropping'] ) )
839 $cropped = wp_crop_image( $attachment_id, (int) $_POST['x1'], (int) $_POST['y1'], (int) $_POST['width'], (int) $_POST['height'], $width, $height );
840 elseif ( ! empty( $_POST['create-new-attachment'] ) )
841 $cropped = _copy_image_file( $attachment_id );
843 $cropped = get_attached_file( $attachment_id );
845 if ( ! $cropped || is_wp_error( $cropped ) )
846 wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) );
848 /** This filter is documented in wp-admin/custom-header.php */
849 $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication
851 $object = $this->create_attachment_object( $cropped, $attachment_id );
853 if ( ! empty( $_POST['create-new-attachment'] ) )
854 unset( $object['ID'] );
856 // Update the attachment
857 $attachment_id = $this->insert_attachment( $object, $cropped );
859 $url = $object['guid'];
860 $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );
863 $medium = str_replace( basename( $original ), 'midsize-' . basename( $original ), $original );
864 if ( file_exists( $medium ) ) {
866 * Filter the path of the file to delete.
870 * @param string $medium Path to the file to delete.
872 @unlink( apply_filters( 'wp_delete_file', $medium ) );
875 if ( empty( $_POST['create-new-attachment'] ) && empty( $_POST['skip-cropping'] ) ) {
876 /** This filter is documented in wp-admin/custom-header.php */
877 @unlink( apply_filters( 'wp_delete_file', $original ) );
880 return $this->finished();
884 * Display last step of custom header image page.
888 function finished() {
889 $this->updated = true;
894 * Display the page based on the current step.
898 function admin_page() {
899 if ( ! current_user_can('edit_theme_options') )
900 wp_die(__('You do not have permission to customize headers.'));
901 $step = $this->step();
904 elseif ( 3 == $step )
911 * Unused since 3.5.0.
915 function attachment_fields_to_edit( $form_fields ) {
920 * Unused since 3.5.0.
924 function filter_upload_tabs( $tabs ) {
929 * Choose a header image, selected from existing uploaded and default headers,
930 * or provide an array of uploaded header data (either new, or from media library).
932 * @param mixed $choice Which header image to select. Allows for values of 'random-default-image',
933 * for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling
934 * among the uploaded images; the key of a default image registered for that theme; and
935 * the key of an image uploaded for that theme (the basename of the URL).
936 * Or an array of arguments: attachment_id, url, width, height. All are required.
940 final public function set_header_image( $choice ) {
941 if ( is_array( $choice ) || is_object( $choice ) ) {
942 $choice = (array) $choice;
943 if ( ! isset( $choice['attachment_id'] ) || ! isset( $choice['url'] ) )
946 $choice['url'] = esc_url_raw( $choice['url'] );
948 $header_image_data = (object) array(
949 'attachment_id' => $choice['attachment_id'],
950 'url' => $choice['url'],
951 'thumbnail_url' => $choice['url'],
952 'height' => $choice['height'],
953 'width' => $choice['width'],
956 update_post_meta( $choice['attachment_id'], '_wp_attachment_is_custom_header', get_stylesheet() );
957 set_theme_mod( 'header_image', $choice['url'] );
958 set_theme_mod( 'header_image_data', $header_image_data );
962 if ( in_array( $choice, array( 'remove-header', 'random-default-image', 'random-uploaded-image' ) ) ) {
963 set_theme_mod( 'header_image', $choice );
964 remove_theme_mod( 'header_image_data' );
968 $uploaded = get_uploaded_header_images();
969 if ( $uploaded && isset( $uploaded[ $choice ] ) ) {
970 $header_image_data = $uploaded[ $choice ];
973 $this->process_default_headers();
974 if ( isset( $this->default_headers[ $choice ] ) )
975 $header_image_data = $this->default_headers[ $choice ];
980 set_theme_mod( 'header_image', esc_url_raw( $header_image_data['url'] ) );
981 set_theme_mod( 'header_image_data', $header_image_data );
985 * Remove a header image.
989 final public function remove_header_image() {
990 return $this->set_header_image( 'remove-header' );
994 * Reset a header image to the default image for the theme.
996 * This method does not do anything if the theme does not have a default header image.
1000 final public function reset_header_image() {
1001 $this->process_default_headers();
1002 $default = get_theme_support( 'custom-header', 'default-image' );
1005 return $this->remove_header_image();
1007 $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
1009 $default_data = array();
1010 foreach ( $this->default_headers as $header => $details ) {
1011 if ( $details['url'] == $default ) {
1012 $default_data = $details;
1017 set_theme_mod( 'header_image', $default );
1018 set_theme_mod( 'header_image_data', (object) $default_data );
1022 * Calculate width and height based on what the currently selected theme supports.
1024 * @return array dst_height and dst_width of header image.
1026 final public function get_header_dimensions( $dimensions ) {
1028 $width = absint( $dimensions['width'] );
1029 $height = absint( $dimensions['height'] );
1030 $theme_height = get_theme_support( 'custom-header', 'height' );
1031 $theme_width = get_theme_support( 'custom-header', 'width' );
1032 $has_flex_width = current_theme_supports( 'custom-header', 'flex-width' );
1033 $has_flex_height = current_theme_supports( 'custom-header', 'flex-height' );
1034 $has_max_width = current_theme_supports( 'custom-header', 'max-width' ) ;
1035 $dst = array( 'dst_height' => null, 'dst_height' => null );
1037 // For flex, limit size of image displayed to 1500px unless theme says otherwise
1038 if ( $has_flex_width ) {
1042 if ( $has_max_width ) {
1043 $max_width = max( $max_width, get_theme_support( 'custom-header', 'max-width' ) );
1045 $max_width = max( $max_width, $theme_width );
1047 if ( $has_flex_height && ( ! $has_flex_width || $width > $max_width ) ) {
1048 $dst['dst_height'] = absint( $height * ( $max_width / $width ) );
1050 elseif ( $has_flex_height && $has_flex_width ) {
1051 $dst['dst_height'] = $height;
1054 $dst['dst_height'] = $theme_height;
1057 if ( $has_flex_width && ( ! $has_flex_height || $width > $max_width ) ) {
1058 $dst['dst_width'] = absint( $width * ( $max_width / $width ) );
1060 elseif ( $has_flex_width && $has_flex_height ) {
1061 $dst['dst_width'] = $width;
1064 $dst['dst_width'] = $theme_width;
1071 * Create an attachment 'object'.
1073 * @param string $cropped Cropped image URL.
1074 * @param int $parent_attachment_id Attachment ID of parent image.
1076 * @return array Attachment object.
1078 final public function create_attachment_object( $cropped, $parent_attachment_id ) {
1079 $parent = get_post( $parent_attachment_id );
1080 $parent_url = $parent->guid;
1081 $url = str_replace( basename( $parent_url ), basename( $cropped ), $parent_url );
1083 $size = @getimagesize( $cropped );
1084 $image_type = ( $size ) ? $size['mime'] : 'image/jpeg';
1087 'ID' => $parent_attachment_id,
1088 'post_title' => basename($cropped),
1089 'post_content' => $url,
1090 'post_mime_type' => $image_type,
1092 'context' => 'custom-header'
1099 * Insert an attachment & its metadata.
1101 * @param array $object Attachment object.
1102 * @param string $cropped Cropped image URL.
1104 * @return int Attachment ID.
1106 final public function insert_attachment( $object, $cropped ) {
1107 $attachment_id = wp_insert_attachment( $object, $cropped );
1108 $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
1110 * Allows us to insert custom meta data for an attachment.
1113 $metadata = apply_filters( 'wp_header_image_attachment_metadata', $metadata );
1114 wp_update_attachment_metadata( $attachment_id, $metadata );
1115 return $attachment_id;
1119 * Gets attachment uploaded by Media Manager, crops it, then saves it as a
1120 * new object. Returns JSON-encoded object details.
1122 function ajax_header_crop() {
1123 check_ajax_referer( 'image_editor-' . $_POST['id'], 'nonce' );
1125 if ( ! current_user_can( 'edit_theme_options' ) ) {
1126 wp_send_json_error();
1129 if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {
1130 wp_send_json_error();
1133 $crop_details = $_POST['cropDetails'];
1135 $dimensions = $this->get_header_dimensions( array(
1136 'height' => $crop_details['height'],
1137 'width' => $crop_details['width'],
1140 $attachment_id = absint( $_POST['id'] );
1142 $cropped = wp_crop_image(
1144 (int) $crop_details['x1'],
1145 (int) $crop_details['y1'],
1146 (int) $crop_details['width'],
1147 (int) $crop_details['height'],
1148 (int) $dimensions['dst_width'],
1149 (int) $dimensions['dst_height']
1152 if ( ! $cropped || is_wp_error( $cropped ) ) {
1153 wp_send_json_error( array( 'message' => __( 'Image could not be processed. Please go back and try again.' ) ) );
1156 $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication
1158 $object = $this->create_attachment_object( $cropped, $attachment_id );
1160 unset( $object['ID'] );
1162 $new_attachment_id = $this->insert_attachment( $object, $cropped );
1164 $object['attachment_id'] = $new_attachment_id;
1165 $object['width'] = $dimensions['dst_width'];
1166 $object['height'] = $dimensions['dst_height'];
1168 wp_send_json_success( $object );
1172 * Given an attachment ID for a header image, updates its "last used"
1175 * Triggered when the user tries adds a new header image from the
1176 * Media Manager, even if s/he doesn't save that change.
1178 function ajax_header_add() {
1179 check_ajax_referer( 'header-add', 'nonce' );
1181 if ( ! current_user_can( 'edit_theme_options' ) ) {
1182 wp_send_json_error();
1185 $attachment_id = absint( $_POST['attachment_id'] );
1186 if ( $attachment_id < 1 ) {
1187 wp_send_json_error();
1190 $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
1191 update_post_meta( $attachment_id, $key, time() );
1192 update_post_meta( $attachment_id, '_wp_attachment_is_custom_header', get_stylesheet() );
1194 wp_send_json_success();
1198 * Given an attachment ID for a header image, unsets it as a user-uploaded
1199 * header image for the current theme.
1201 * Triggered when the user clicks the overlay "X" button next to each image
1202 * choice in the Customizer's Header tool.
1204 function ajax_header_remove() {
1205 check_ajax_referer( 'header-remove', 'nonce' );
1207 if ( ! current_user_can( 'edit_theme_options' ) ) {
1208 wp_send_json_error();
1211 $attachment_id = absint( $_POST['attachment_id'] );
1212 if ( $attachment_id < 1 ) {
1213 wp_send_json_error();
1216 $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
1217 delete_post_meta( $attachment_id, $key );
1218 delete_post_meta( $attachment_id, '_wp_attachment_is_custom_header', get_stylesheet() );
1220 wp_send_json_success();
1223 function customize_set_last_used( $wp_customize ) {
1224 $data = $wp_customize->get_setting( 'header_image_data' )->post_value();
1226 if ( ! isset( $data['attachment_id'] ) ) {
1230 $attachment_id = $data['attachment_id'];
1231 $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
1232 update_post_meta( $attachment_id, $key, time() );
1235 public function get_default_header_images() {
1236 $this->process_default_headers();
1238 // Get the default image if there is one.
1239 $default = get_theme_support( 'custom-header', 'default-image' );
1241 if ( ! $default ) { // If not,
1242 return $this->default_headers; // easy peasy.
1245 $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
1246 $already_has_default = false;
1248 foreach ( $this->default_headers as $k => $h ) {
1249 if ( $h['url'] === $default ) {
1250 $already_has_default = true;
1255 if ( $already_has_default ) {
1256 return $this->default_headers;
1259 // If the one true image isn't included in the default set, prepend it.
1260 $header_images = array();
1261 $header_images['default'] = array(
1263 'thumbnail_url' => $default,
1264 'description' => 'Default'
1267 // The rest of the set comes after.
1268 $header_images = array_merge( $header_images, $this->default_headers );
1269 return $header_images;
1272 public function get_uploaded_header_images() {
1273 $header_images = get_uploaded_header_images();
1274 $timestamp_key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
1275 $alt_text_key = '_wp_attachment_image_alt';
1277 foreach ( $header_images as &$header_image ) {
1278 $header_meta = get_post_meta( $header_image['attachment_id'] );
1279 $header_image['timestamp'] = isset( $header_meta[ $timestamp_key ] ) ? $header_meta[ $timestamp_key ] : '';
1280 $header_image['alt_text'] = isset( $header_meta[ $alt_text_key ] ) ? $header_meta[ $alt_text_key ] : '';
1283 return $header_images;