' . __( 'The current theme does not support uploading a custom header image.' ) . '
',
+ 403
+ );
+ }
if ( empty( $_POST ) && isset( $_GET['file'] ) ) {
$attachment_id = absint( $_GET['file'] );
$file = get_attached_file( $attachment_id, true );
- $url = wp_get_attachment_image_src( $attachment_id, 'full');
+ $url = wp_get_attachment_image_src( $attachment_id, 'full' );
$url = $url[0];
} elseif ( isset( $_POST ) ) {
- extract($this->step_2_manage_upload());
+ $data = $this->step_2_manage_upload();
+ $attachment_id = $data['attachment_id'];
+ $file = $data['file'];
+ $url = $data['url'];
}
if ( file_exists( $file ) ) {
@@ -724,15 +798,14 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
?>
-
-
+
@@ -764,11 +837,11 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
*
* @since 3.4.0
*/
- function step_2_manage_upload() {
+ public function step_2_manage_upload() {
$overrides = array('test_form' => false);
$uploaded_file = $_FILES['import'];
- $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'], false );
+ $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'] );
if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) )
wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) );
@@ -800,15 +873,27 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
* Display third step of custom header image page.
*
* @since 2.1.0
+ * @since 4.4.0 Switched to using wp_get_attachment_url() instead of the guid
+ * for retrieving the header image URL.
*/
- function step_3() {
+ public function step_3() {
check_admin_referer( 'custom-header-crop-image' );
- if ( ! current_theme_supports( 'custom-header', 'uploads' ) )
- wp_die( __( 'Cheatin’ uh?' ) );
+ if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {
+ wp_die(
+ '
' . __( 'Cheatin’ uh?' ) . '
' .
+ '
' . __( 'The current theme does not support uploading a custom header image.' ) . '
',
+ 403
+ );
+ }
- if ( ! empty( $_POST['skip-cropping'] ) && ! ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) )
- wp_die( __( 'Cheatin’ uh?' ) );
+ if ( ! empty( $_POST['skip-cropping'] ) && ! ( current_theme_supports( 'custom-header', 'flex-height' ) || current_theme_supports( 'custom-header', 'flex-width' ) ) ) {
+ wp_die(
+ '
' . __( 'Cheatin’ uh?' ) . '
' .
+ '
' . __( 'The current theme does not support a flexible sized header image.' ) . '
',
+ 403
+ );
+ }
if ( $_POST['oitar'] > 1 ) {
$_POST['x1'] = $_POST['x1'] * $_POST['oitar'];
@@ -820,32 +905,15 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
$attachment_id = absint( $_POST['attachment_id'] );
$original = get_attached_file($attachment_id);
-
- $max_width = 0;
- // For flex, limit size of image displayed to 1500px unless theme says otherwise
- if ( current_theme_supports( 'custom-header', 'flex-width' ) )
- $max_width = 1500;
-
- if ( current_theme_supports( 'custom-header', 'max-width' ) )
- $max_width = max( $max_width, get_theme_support( 'custom-header', 'max-width' ) );
- $max_width = max( $max_width, get_theme_support( 'custom-header', 'width' ) );
-
- if ( ( current_theme_supports( 'custom-header', 'flex-height' ) && ! current_theme_supports( 'custom-header', 'flex-width' ) ) || $_POST['width'] > $max_width )
- $dst_height = absint( $_POST['height'] * ( $max_width / $_POST['width'] ) );
- elseif ( current_theme_supports( 'custom-header', 'flex-height' ) && current_theme_supports( 'custom-header', 'flex-width' ) )
- $dst_height = absint( $_POST['height'] );
- else
- $dst_height = get_theme_support( 'custom-header', 'height' );
-
- if ( ( current_theme_supports( 'custom-header', 'flex-width' ) && ! current_theme_supports( 'custom-header', 'flex-height' ) ) || $_POST['width'] > $max_width )
- $dst_width = absint( $_POST['width'] * ( $max_width / $_POST['width'] ) );
- elseif ( current_theme_supports( 'custom-header', 'flex-width' ) && current_theme_supports( 'custom-header', 'flex-height' ) )
- $dst_width = absint( $_POST['width'] );
- else
- $dst_width = get_theme_support( 'custom-header', 'width' );
+ $dimensions = $this->get_header_dimensions( array(
+ 'height' => $_POST['height'],
+ 'width' => $_POST['width'],
+ ) );
+ $height = $dimensions['dst_height'];
+ $width = $dimensions['dst_width'];
if ( empty( $_POST['skip-cropping'] ) )
- $cropped = wp_crop_image( $attachment_id, (int) $_POST['x1'], (int) $_POST['y1'], (int) $_POST['width'], (int) $_POST['height'], $dst_width, $dst_height );
+ $cropped = wp_crop_image( $attachment_id, (int) $_POST['x1'], (int) $_POST['y1'], (int) $_POST['width'], (int) $_POST['height'], $width, $height );
elseif ( ! empty( $_POST['create-new-attachment'] ) )
$cropped = _copy_image_file( $attachment_id );
else
@@ -857,49 +925,25 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
/** This filter is documented in wp-admin/custom-header.php */
$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication
- $parent = get_post($attachment_id);
- $parent_url = $parent->guid;
- $url = str_replace( basename( $parent_url ), basename( $cropped ), $parent_url );
+ $object = $this->create_attachment_object( $cropped, $attachment_id );
- $size = @getimagesize( $cropped );
- $image_type = ( $size ) ? $size['mime'] : 'image/jpeg';
-
- // Construct the object array
- $object = array(
- 'ID' => $attachment_id,
- 'post_title' => basename($cropped),
- 'post_content' => $url,
- 'post_mime_type' => $image_type,
- 'guid' => $url,
- 'context' => 'custom-header'
- );
if ( ! empty( $_POST['create-new-attachment'] ) )
unset( $object['ID'] );
// Update the attachment
- $attachment_id = wp_insert_attachment( $object, $cropped );
- wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $cropped ) );
+ $attachment_id = $this->insert_attachment( $object, $cropped );
- $width = $dst_width;
- $height = $dst_height;
+ $url = wp_get_attachment_url( $attachment_id );
$this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );
- // cleanup
+ // Cleanup.
$medium = str_replace( basename( $original ), 'midsize-' . basename( $original ), $original );
if ( file_exists( $medium ) ) {
- /**
- * Filter the path of the file to delete.
- *
- * @since 2.1.0
- *
- * @param string $medium Path to the file to delete.
- */
- @unlink( apply_filters( 'wp_delete_file', $medium ) );
+ wp_delete_file( $medium );
}
if ( empty( $_POST['create-new-attachment'] ) && empty( $_POST['skip-cropping'] ) ) {
- /** This filter is documented in wp-admin/custom-header.php */
- @unlink( apply_filters( 'wp_delete_file', $original ) );
+ wp_delete_file( $original );
}
return $this->finished();
@@ -910,7 +954,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
*
* @since 2.1.0
*/
- function finished() {
+ public function finished() {
$this->updated = true;
$this->step_1();
}
@@ -920,9 +964,9 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
*
* @since 2.1.0
*/
- function admin_page() {
+ public function admin_page() {
if ( ! current_user_can('edit_theme_options') )
- wp_die(__('You do not have permission to customize headers.'));
+ wp_die(__('Sorry, you are not allowed to customize headers.'));
$step = $this->step();
if ( 2 == $step )
$this->step_2();
@@ -936,8 +980,11 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
* Unused since 3.5.0.
*
* @since 3.4.0
+ *
+ * @param array $form_fields
+ * @return array $form_fields
*/
- function attachment_fields_to_edit( $form_fields ) {
+ public function attachment_fields_to_edit( $form_fields ) {
return $form_fields;
}
@@ -945,8 +992,11 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
* Unused since 3.5.0.
*
* @since 3.4.0
+ *
+ * @param array $tabs
+ * @return array $tabs
*/
- function filter_upload_tabs( $tabs ) {
+ public function filter_upload_tabs( $tabs ) {
return $tabs;
}
@@ -954,13 +1004,13 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
* Choose a header image, selected from existing uploaded and default headers,
* or provide an array of uploaded header data (either new, or from media library).
*
+ * @since 3.4.0
+ *
* @param mixed $choice Which header image to select. Allows for values of 'random-default-image',
* for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling
* among the uploaded images; the key of a default image registered for that theme; and
- * the key of an image uploaded for that theme (the basename of the URL).
+ * the key of an image uploaded for that theme (the attachment ID of the image).
* Or an array of arguments: attachment_id, url, width, height. All are required.
- *
- * @since 3.4.0
*/
final public function set_header_image( $choice ) {
if ( is_array( $choice ) || is_object( $choice ) ) {
@@ -1012,7 +1062,7 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
* @since 3.4.0
*/
final public function remove_header_image() {
- return $this->set_header_image( 'remove-header' );
+ $this->set_header_image( 'remove-header' );
}
/**
@@ -1026,9 +1076,10 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
$this->process_default_headers();
$default = get_theme_support( 'custom-header', 'default-image' );
- if ( ! $default )
- return $this->remove_header_image();
-
+ if ( ! $default ) {
+ $this->remove_header_image();
+ return;
+ }
$default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
$default_data = array();
@@ -1042,4 +1093,287 @@ wp_nonce_field( 'custom-header-options', '_wpnonce-custom-header-options' ); ?>
set_theme_mod( 'header_image', $default );
set_theme_mod( 'header_image_data', (object) $default_data );
}
+
+ /**
+ * Calculate width and height based on what the currently selected theme supports.
+ *
+ * @param array $dimensions
+ * @return array dst_height and dst_width of header image.
+ */
+ final public function get_header_dimensions( $dimensions ) {
+ $max_width = 0;
+ $width = absint( $dimensions['width'] );
+ $height = absint( $dimensions['height'] );
+ $theme_height = get_theme_support( 'custom-header', 'height' );
+ $theme_width = get_theme_support( 'custom-header', 'width' );
+ $has_flex_width = current_theme_supports( 'custom-header', 'flex-width' );
+ $has_flex_height = current_theme_supports( 'custom-header', 'flex-height' );
+ $has_max_width = current_theme_supports( 'custom-header', 'max-width' ) ;
+ $dst = array( 'dst_height' => null, 'dst_width' => null );
+
+ // For flex, limit size of image displayed to 1500px unless theme says otherwise
+ if ( $has_flex_width ) {
+ $max_width = 1500;
+ }
+
+ if ( $has_max_width ) {
+ $max_width = max( $max_width, get_theme_support( 'custom-header', 'max-width' ) );
+ }
+ $max_width = max( $max_width, $theme_width );
+
+ if ( $has_flex_height && ( ! $has_flex_width || $width > $max_width ) ) {
+ $dst['dst_height'] = absint( $height * ( $max_width / $width ) );
+ }
+ elseif ( $has_flex_height && $has_flex_width ) {
+ $dst['dst_height'] = $height;
+ }
+ else {
+ $dst['dst_height'] = $theme_height;
+ }
+
+ if ( $has_flex_width && ( ! $has_flex_height || $width > $max_width ) ) {
+ $dst['dst_width'] = absint( $width * ( $max_width / $width ) );
+ }
+ elseif ( $has_flex_width && $has_flex_height ) {
+ $dst['dst_width'] = $width;
+ }
+ else {
+ $dst['dst_width'] = $theme_width;
+ }
+
+ return $dst;
+ }
+
+ /**
+ * Create an attachment 'object'.
+ *
+ * @param string $cropped Cropped image URL.
+ * @param int $parent_attachment_id Attachment ID of parent image.
+ *
+ * @return array Attachment object.
+ */
+ final public function create_attachment_object( $cropped, $parent_attachment_id ) {
+ $parent = get_post( $parent_attachment_id );
+ $parent_url = wp_get_attachment_url( $parent->ID );
+ $url = str_replace( basename( $parent_url ), basename( $cropped ), $parent_url );
+
+ $size = @getimagesize( $cropped );
+ $image_type = ( $size ) ? $size['mime'] : 'image/jpeg';
+
+ $object = array(
+ 'ID' => $parent_attachment_id,
+ 'post_title' => basename($cropped),
+ 'post_mime_type' => $image_type,
+ 'guid' => $url,
+ 'context' => 'custom-header'
+ );
+
+ return $object;
+ }
+
+ /**
+ * Insert an attachment and its metadata.
+ *
+ * @param array $object Attachment object.
+ * @param string $cropped Cropped image URL.
+ *
+ * @return int Attachment ID.
+ */
+ final public function insert_attachment( $object, $cropped ) {
+ $attachment_id = wp_insert_attachment( $object, $cropped );
+ $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
+ /**
+ * Filters the header image attachment metadata.
+ *
+ * @since 3.9.0
+ *
+ * @see wp_generate_attachment_metadata()
+ *
+ * @param array $metadata Attachment metadata.
+ */
+ $metadata = apply_filters( 'wp_header_image_attachment_metadata', $metadata );
+ wp_update_attachment_metadata( $attachment_id, $metadata );
+ return $attachment_id;
+ }
+
+ /**
+ * Gets attachment uploaded by Media Manager, crops it, then saves it as a
+ * new object. Returns JSON-encoded object details.
+ */
+ public function ajax_header_crop() {
+ check_ajax_referer( 'image_editor-' . $_POST['id'], 'nonce' );
+
+ if ( ! current_user_can( 'edit_theme_options' ) ) {
+ wp_send_json_error();
+ }
+
+ if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {
+ wp_send_json_error();
+ }
+
+ $crop_details = $_POST['cropDetails'];
+
+ $dimensions = $this->get_header_dimensions( array(
+ 'height' => $crop_details['height'],
+ 'width' => $crop_details['width'],
+ ) );
+
+ $attachment_id = absint( $_POST['id'] );
+
+ $cropped = wp_crop_image(
+ $attachment_id,
+ (int) $crop_details['x1'],
+ (int) $crop_details['y1'],
+ (int) $crop_details['width'],
+ (int) $crop_details['height'],
+ (int) $dimensions['dst_width'],
+ (int) $dimensions['dst_height']
+ );
+
+ if ( ! $cropped || is_wp_error( $cropped ) ) {
+ wp_send_json_error( array( 'message' => __( 'Image could not be processed. Please go back and try again.' ) ) );
+ }
+
+ /** This filter is documented in wp-admin/custom-header.php */
+ $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication
+
+ $object = $this->create_attachment_object( $cropped, $attachment_id );
+
+ unset( $object['ID'] );
+
+ $new_attachment_id = $this->insert_attachment( $object, $cropped );
+
+ $object['attachment_id'] = $new_attachment_id;
+ $object['url'] = wp_get_attachment_url( $new_attachment_id );;
+ $object['width'] = $dimensions['dst_width'];
+ $object['height'] = $dimensions['dst_height'];
+
+ wp_send_json_success( $object );
+ }
+
+ /**
+ * Given an attachment ID for a header image, updates its "last used"
+ * timestamp to now.
+ *
+ * Triggered when the user tries adds a new header image from the
+ * Media Manager, even if s/he doesn't save that change.
+ */
+ public function ajax_header_add() {
+ check_ajax_referer( 'header-add', 'nonce' );
+
+ if ( ! current_user_can( 'edit_theme_options' ) ) {
+ wp_send_json_error();
+ }
+
+ $attachment_id = absint( $_POST['attachment_id'] );
+ if ( $attachment_id < 1 ) {
+ wp_send_json_error();
+ }
+
+ $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
+ update_post_meta( $attachment_id, $key, time() );
+ update_post_meta( $attachment_id, '_wp_attachment_is_custom_header', get_stylesheet() );
+
+ wp_send_json_success();
+ }
+
+ /**
+ * Given an attachment ID for a header image, unsets it as a user-uploaded
+ * header image for the current theme.
+ *
+ * Triggered when the user clicks the overlay "X" button next to each image
+ * choice in the Customizer's Header tool.
+ */
+ public function ajax_header_remove() {
+ check_ajax_referer( 'header-remove', 'nonce' );
+
+ if ( ! current_user_can( 'edit_theme_options' ) ) {
+ wp_send_json_error();
+ }
+
+ $attachment_id = absint( $_POST['attachment_id'] );
+ if ( $attachment_id < 1 ) {
+ wp_send_json_error();
+ }
+
+ $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
+ delete_post_meta( $attachment_id, $key );
+ delete_post_meta( $attachment_id, '_wp_attachment_is_custom_header', get_stylesheet() );
+
+ wp_send_json_success();
+ }
+
+ /**
+ *
+ * @param WP_Customize_Manager $wp_customize
+ */
+ public function customize_set_last_used( $wp_customize ) {
+ $data = $wp_customize->get_setting( 'header_image_data' )->post_value();
+
+ if ( ! isset( $data['attachment_id'] ) ) {
+ return;
+ }
+
+ $attachment_id = $data['attachment_id'];
+ $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
+ update_post_meta( $attachment_id, $key, time() );
+ }
+
+ /**
+ *
+ * @return array
+ */
+ public function get_default_header_images() {
+ $this->process_default_headers();
+
+ // Get the default image if there is one.
+ $default = get_theme_support( 'custom-header', 'default-image' );
+
+ if ( ! $default ) { // If not,
+ return $this->default_headers; // easy peasy.
+ }
+
+ $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
+ $already_has_default = false;
+
+ foreach ( $this->default_headers as $k => $h ) {
+ if ( $h['url'] === $default ) {
+ $already_has_default = true;
+ break;
+ }
+ }
+
+ if ( $already_has_default ) {
+ return $this->default_headers;
+ }
+
+ // If the one true image isn't included in the default set, prepend it.
+ $header_images = array();
+ $header_images['default'] = array(
+ 'url' => $default,
+ 'thumbnail_url' => $default,
+ 'description' => 'Default'
+ );
+
+ // The rest of the set comes after.
+ return array_merge( $header_images, $this->default_headers );
+ }
+
+ /**
+ *
+ * @return array
+ */
+ public function get_uploaded_header_images() {
+ $header_images = get_uploaded_header_images();
+ $timestamp_key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
+ $alt_text_key = '_wp_attachment_image_alt';
+
+ foreach ( $header_images as &$header_image ) {
+ $header_meta = get_post_meta( $header_image['attachment_id'] );
+ $header_image['timestamp'] = isset( $header_meta[ $timestamp_key ] ) ? $header_meta[ $timestamp_key ] : '';
+ $header_image['alt_text'] = isset( $header_meta[ $alt_text_key ] ) ? $header_meta[ $alt_text_key ] : '';
+ }
+
+ return $header_images;
+ }
}