From 24d08a9463e689b5faac84eb993cbb30de4513f0 Mon Sep 17 00:00:00 2001 From: Gary Pendergast Date: Wed, 17 Jul 2019 06:17:56 +0000 Subject: [PATCH] Coding Standards: Move `wp-admin/custom-header.php` to `wp-admin/includes/class-custom-image-header.php` This renames the file containing the `Custom_Image_Header` class to conform to the coding standards. This commit also includes: - A new `custom-header.php` that includes the new file, for anyone that may've been including the file directly. - Replaces references to the old filename with the new filename. See #47632. Built from https://develop.svn.wordpress.org/trunk@45654 git-svn-id: http://core.svn.wordpress.org/trunk@45465 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/custom-background.php | 2 +- wp-admin/custom-header.php | 1501 +--------------- wp-admin/includes/ajax-actions.php | 4 +- .../includes/class-custom-image-header.php | 1502 +++++++++++++++++ ...lass-wp-customize-header-image-setting.php | 2 +- wp-includes/theme.php | 2 +- wp-includes/version.php | 2 +- 7 files changed, 1515 insertions(+), 1500 deletions(-) create mode 100644 wp-admin/includes/class-custom-image-header.php diff --git a/wp-admin/custom-background.php b/wp-admin/custom-background.php index 547611fa41..49bd29fb0e 100644 --- a/wp-admin/custom-background.php +++ b/wp-admin/custom-background.php @@ -518,7 +518,7 @@ class Custom_Background { $thumbnail = wp_get_attachment_image_src( $id, 'thumbnail' ); set_theme_mod( 'background_image_thumb', esc_url_raw( $thumbnail[0] ) ); - /** This action is documented in wp-admin/custom-header.php */ + /** This action is documented in wp-admin/includes/class-custom-image-header.php */ do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication $this->updated = true; } diff --git a/wp-admin/custom-header.php b/wp-admin/custom-header.php index 97e7c08e7b..d99f192da8 100644 --- a/wp-admin/custom-header.php +++ b/wp-admin/custom-header.php @@ -1,1502 +1,15 @@ admin_header_callback = $admin_header_callback; - $this->admin_image_div_callback = $admin_image_div_callback; - - add_action( 'admin_menu', array( $this, 'init' ) ); - - add_action( 'customize_save_after', array( $this, 'customize_set_last_used' ) ); - add_action( 'wp_ajax_custom-header-crop', array( $this, 'ajax_header_crop' ) ); - add_action( 'wp_ajax_custom-header-add', array( $this, 'ajax_header_add' ) ); - add_action( 'wp_ajax_custom-header-remove', array( $this, 'ajax_header_remove' ) ); - } - - /** - * Set up the hooks for the Custom Header admin page. - * - * @since 2.1.0 - */ - public function init() { - $page = add_theme_page( __( 'Header' ), __( 'Header' ), 'edit_theme_options', 'custom-header', array( $this, 'admin_page' ) ); - if ( ! $page ) { - return; - } - - add_action( "admin_print_scripts-$page", array( $this, 'js_includes' ) ); - add_action( "admin_print_styles-$page", array( $this, 'css_includes' ) ); - add_action( "admin_head-$page", array( $this, 'help' ) ); - add_action( "admin_head-$page", array( $this, 'take_action' ), 50 ); - add_action( "admin_head-$page", array( $this, 'js' ), 50 ); - if ( $this->admin_header_callback ) { - add_action( "admin_head-$page", $this->admin_header_callback, 51 ); - } - } - - /** - * Adds contextual help. - * - * @since 3.0.0 - */ - public function help() { - get_current_screen()->add_help_tab( - array( - 'id' => 'overview', - 'title' => __( 'Overview' ), - 'content' => - '

' . __( 'This screen is used to customize the header section of your theme.' ) . '

' . - '

' . __( '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.' ) . '

', - ) - ); - - get_current_screen()->add_help_tab( - array( - 'id' => 'set-header-image', - 'title' => __( 'Header Image' ), - 'content' => - '

' . __( '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.' ) . '

' . - '

' . __( '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.' ) . '

' . - '

' . __( '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.' ) . '

' . - '

' . __( '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”.' ) . '

', - ) - ); - - get_current_screen()->add_help_tab( - array( - 'id' => 'set-header-text', - 'title' => __( 'Header Text' ), - 'content' => - '

' . sprintf( __( 'For most themes, the header text is your Site Title and Tagline, as defined in the General Settings section.' ), admin_url( 'options-general.php' ) ) . '

' . - '

' . __( '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.' ) . '

' . - '

' . __( 'Don’t forget to click “Save Changes” when you’re done!' ) . '

', - ) - ); - - get_current_screen()->set_help_sidebar( - '

' . __( 'For more information:' ) . '

' . - '

' . __( 'Documentation on Custom Header' ) . '

' . - '

' . __( 'Support' ) . '

' - ); - } - - /** - * Get the current step. - * - * @since 2.6.0 - * - * @return int Current step - */ - public function step() { - if ( ! isset( $_GET['step'] ) ) { - return 1; - } - - $step = (int) $_GET['step']; - if ( $step < 1 || 3 < $step || - ( 2 == $step && ! wp_verify_nonce( $_REQUEST['_wpnonce-custom-header-upload'], 'custom-header-upload' ) ) || - ( 3 == $step && ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'custom-header-crop-image' ) ) - ) { - return 1; - } - - return $step; - } - - /** - * Set up the enqueue for the JavaScript files. - * - * @since 2.1.0 - */ - public function js_includes() { - $step = $this->step(); - - if ( ( 1 == $step || 3 == $step ) ) { - wp_enqueue_media(); - wp_enqueue_script( 'custom-header' ); - if ( current_theme_supports( 'custom-header', 'header-text' ) ) { - wp_enqueue_script( 'wp-color-picker' ); - } - } elseif ( 2 == $step ) { - wp_enqueue_script( 'imgareaselect' ); - } - } - - /** - * Set up the enqueue for the CSS files - * - * @since 2.7.0 - */ - public function css_includes() { - $step = $this->step(); - - if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) ) { - wp_enqueue_style( 'wp-color-picker' ); - } elseif ( 2 == $step ) { - wp_enqueue_style( 'imgareaselect' ); - } - } - - /** - * Execute custom header modification. - * - * @since 2.6.0 - */ - public function take_action() { - if ( ! current_user_can( 'edit_theme_options' ) ) { - return; - } - - if ( empty( $_POST ) ) { - return; - } - - $this->updated = true; - - if ( isset( $_POST['resetheader'] ) ) { - check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); - $this->reset_header_image(); - return; - } - - if ( isset( $_POST['removeheader'] ) ) { - check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); - $this->remove_header_image(); - return; - } - - if ( isset( $_POST['text-color'] ) && ! isset( $_POST['display-header-text'] ) ) { - check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); - set_theme_mod( 'header_textcolor', 'blank' ); - } elseif ( isset( $_POST['text-color'] ) ) { - check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); - $_POST['text-color'] = str_replace( '#', '', $_POST['text-color'] ); - $color = preg_replace( '/[^0-9a-fA-F]/', '', $_POST['text-color'] ); - if ( strlen( $color ) == 6 || strlen( $color ) == 3 ) { - set_theme_mod( 'header_textcolor', $color ); - } elseif ( ! $color ) { - set_theme_mod( 'header_textcolor', 'blank' ); - } - } - - if ( isset( $_POST['default-header'] ) ) { - check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); - $this->set_header_image( $_POST['default-header'] ); - return; - } - } - - /** - * Process the default headers - * - * @since 3.0.0 - * - * @global array $_wp_default_headers - */ - public function process_default_headers() { - global $_wp_default_headers; - - if ( ! isset( $_wp_default_headers ) ) { - return; - } - - if ( ! empty( $this->default_headers ) ) { - return; - } - - $this->default_headers = $_wp_default_headers; - $template_directory_uri = get_template_directory_uri(); - $stylesheet_directory_uri = get_stylesheet_directory_uri(); - foreach ( array_keys( $this->default_headers ) as $header ) { - $this->default_headers[ $header ]['url'] = sprintf( $this->default_headers[ $header ]['url'], $template_directory_uri, $stylesheet_directory_uri ); - $this->default_headers[ $header ]['thumbnail_url'] = sprintf( $this->default_headers[ $header ]['thumbnail_url'], $template_directory_uri, $stylesheet_directory_uri ); - } - } - - /** - * Display UI for selecting one of several default headers. - * - * Show the random image option if this theme has multiple header images. - * Random image option is on by default if no header has been set. - * - * @since 3.0.0 - * - * @param string $type The header type. One of 'default' (for the Uploaded Images control) - * or 'uploaded' (for the Uploaded Images control). - */ - public function show_header_selector( $type = 'default' ) { - if ( 'default' == $type ) { - $headers = $this->default_headers; - } else { - $headers = get_uploaded_header_images(); - $type = 'uploaded'; - } - - if ( 1 < count( $headers ) ) { - echo '
'; - echo ''; - echo '
'; - } - - echo '
'; - foreach ( $headers as $header_key => $header ) { - $header_thumbnail = $header['thumbnail_url']; - $header_url = $header['url']; - $header_alt_text = empty( $header['alt_text'] ) ? '' : $header['alt_text']; - echo '
'; - echo ''; - echo '
'; - } - echo '
'; - } - - /** - * Execute JavaScript depending on step. - * - * @since 2.1.0 - */ - public function js() { - $step = $this->step(); - if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) ) { - $this->js_1(); - } elseif ( 2 == $step ) { - $this->js_2(); - } - } - - /** - * Display JavaScript based on Step 1 and 3. - * - * @since 2.6.0 - */ - public function js_1() { - $default_color = ''; - if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) { - $default_color = get_theme_support( 'custom-header', 'default-text-color' ); - if ( $default_color && false === strpos( $default_color, '#' ) ) { - $default_color = '#' . $default_color; - } - } - ?> - - - - process_default_headers(); - ?> - -
-

- - -
-

- Customizer.' ), - admin_url( 'customize.php?autofocus[control]=header_image' ) - ); - ?> -

-
- - - updated ) ) { ?> -
-

Visit your site to see how it looks.' ), home_url( '/' ) ); ?>

-
- - -

- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - default_headers ) ) : - ?> - - - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - - - - - - - - -
-
- - ' . __( 'Something went wrong.' ) . '' . - '

' . __( '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 = $url[0]; - } elseif ( isset( $_POST ) ) { - $data = $this->step_2_manage_upload(); - $attachment_id = $data['attachment_id']; - $file = $data['file']; - $url = $data['url']; - } - - if ( file_exists( $file ) ) { - list( $width, $height, $type, $attr ) = @getimagesize( $file ); - } else { - $data = wp_get_attachment_metadata( $attachment_id ); - $height = isset( $data['height'] ) ? $data['height'] : 0; - $width = isset( $data['width'] ) ? $data['width'] : 0; - unset( $data ); - } - - $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 flexible height isn't supported and the image is the exact right size - if ( ! current_theme_supports( 'custom-header', 'flex-height' ) && ! current_theme_supports( 'custom-header', 'flex-width' ) - && $width == get_theme_support( 'custom-header', 'width' ) && $height == get_theme_support( 'custom-header', 'height' ) ) { - // Add the meta-data - if ( file_exists( $file ) ) { - wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) ); - } - - $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) ); - - /** - * Fires after the header image is set or an error is returned. - * - * @since 2.1.0 - * - * @param string $file Path to the file. - * @param int $attachment_id Attachment ID. - */ - do_action( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication - - return $this->finished(); - } elseif ( $width > $max_width ) { - $oitar = $width / $max_width; - $image = wp_crop_image( $attachment_id, 0, 0, $width, $height, $max_width, $height / $oitar, false, str_replace( wp_basename( $file ), 'midsize-' . wp_basename( $file ), $file ) ); - if ( ! $image || is_wp_error( $image ) ) { - wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) ); - } - - /** This filter is documented in wp-admin/custom-header.php */ - $image = apply_filters( 'wp_create_file_in_uploads', $image, $attachment_id ); // For replication - - $url = str_replace( wp_basename( $url ), wp_basename( $image ), $url ); - $width = $width / $oitar; - $height = $height / $oitar; - } else { - $oitar = 1; - } - ?> - -
-

- -
-

-

- -
- -
- - - - - - - - - - - - -

- - -

-
-
- false ); - - $uploaded_file = $_FILES['import']; - $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.' ) ); - } - - $file = wp_handle_upload( $uploaded_file, $overrides ); - - if ( isset( $file['error'] ) ) { - wp_die( $file['error'], __( 'Image Upload Error' ) ); - } - - $url = $file['url']; - $type = $file['type']; - $file = $file['file']; - $filename = wp_basename( $file ); - - // Construct the object array - $object = array( - 'post_title' => $filename, - 'post_content' => $url, - 'post_mime_type' => $type, - 'guid' => $url, - 'context' => 'custom-header', - ); - - // Save the data - $attachment_id = wp_insert_attachment( $object, $file ); - return compact( 'attachment_id', 'file', 'filename', 'url', 'type' ); - } - - /** - * 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. - */ - public function step_3() { - check_admin_referer( 'custom-header-crop-image' ); - - if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) { - wp_die( - '

' . __( 'Something went wrong.' ) . '

' . - '

' . __( '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( - '

' . __( 'Something went wrong.' ) . '

' . - '

' . __( 'The current theme does not support a flexible sized header image.' ) . '

', - 403 - ); - } - - if ( $_POST['oitar'] > 1 ) { - $_POST['x1'] = $_POST['x1'] * $_POST['oitar']; - $_POST['y1'] = $_POST['y1'] * $_POST['oitar']; - $_POST['width'] = $_POST['width'] * $_POST['oitar']; - $_POST['height'] = $_POST['height'] * $_POST['oitar']; - } - - $attachment_id = absint( $_POST['attachment_id'] ); - $original = get_attached_file( $attachment_id ); - - $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'], $width, $height ); - } elseif ( ! empty( $_POST['create-new-attachment'] ) ) { - $cropped = _copy_image_file( $attachment_id ); - } else { - $cropped = get_attached_file( $attachment_id ); - } - - if ( ! $cropped || is_wp_error( $cropped ) ) { - wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) ); - } - - /** 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 ); - - if ( ! empty( $_POST['create-new-attachment'] ) ) { - unset( $object['ID'] ); - } - - // Update the attachment - $attachment_id = $this->insert_attachment( $object, $cropped ); - - $url = wp_get_attachment_url( $attachment_id ); - $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) ); - - // Cleanup. - $medium = str_replace( wp_basename( $original ), 'midsize-' . wp_basename( $original ), $original ); - if ( file_exists( $medium ) ) { - wp_delete_file( $medium ); - } - - if ( empty( $_POST['create-new-attachment'] ) && empty( $_POST['skip-cropping'] ) ) { - wp_delete_file( $original ); - } - - return $this->finished(); - } - - /** - * Display last step of custom header image page. - * - * @since 2.1.0 - */ - public function finished() { - $this->updated = true; - $this->step_1(); - } - - /** - * Display the page based on the current step. - * - * @since 2.1.0 - */ - public function admin_page() { - if ( ! current_user_can( 'edit_theme_options' ) ) { - wp_die( __( 'Sorry, you are not allowed to customize headers.' ) ); - } - $step = $this->step(); - if ( 2 == $step ) { - $this->step_2(); - } elseif ( 3 == $step ) { - $this->step_3(); - } else { - $this->step_1(); - } - } - - /** - * Unused since 3.5.0. - * - * @since 3.4.0 - * - * @param array $form_fields - * @return array $form_fields - */ - public function attachment_fields_to_edit( $form_fields ) { - return $form_fields; - } - - /** - * Unused since 3.5.0. - * - * @since 3.4.0 - * - * @param array $tabs - * @return array $tabs - */ - public function filter_upload_tabs( $tabs ) { - return $tabs; - } - - /** - * 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 attachment ID of the image). - * Or an array of arguments: attachment_id, url, width, height. All are required. - */ - final public function set_header_image( $choice ) { - if ( is_array( $choice ) || is_object( $choice ) ) { - $choice = (array) $choice; - if ( ! isset( $choice['attachment_id'] ) || ! isset( $choice['url'] ) ) { - return; - } - - $choice['url'] = esc_url_raw( $choice['url'] ); - - $header_image_data = (object) array( - 'attachment_id' => $choice['attachment_id'], - 'url' => $choice['url'], - 'thumbnail_url' => $choice['url'], - 'height' => $choice['height'], - 'width' => $choice['width'], - ); - - update_post_meta( $choice['attachment_id'], '_wp_attachment_is_custom_header', get_stylesheet() ); - set_theme_mod( 'header_image', $choice['url'] ); - set_theme_mod( 'header_image_data', $header_image_data ); - return; - } - - if ( in_array( $choice, array( 'remove-header', 'random-default-image', 'random-uploaded-image' ) ) ) { - set_theme_mod( 'header_image', $choice ); - remove_theme_mod( 'header_image_data' ); - return; - } - - $uploaded = get_uploaded_header_images(); - if ( $uploaded && isset( $uploaded[ $choice ] ) ) { - $header_image_data = $uploaded[ $choice ]; - - } else { - $this->process_default_headers(); - if ( isset( $this->default_headers[ $choice ] ) ) { - $header_image_data = $this->default_headers[ $choice ]; - } else { - return; - } - } - - set_theme_mod( 'header_image', esc_url_raw( $header_image_data['url'] ) ); - set_theme_mod( 'header_image_data', $header_image_data ); - } - - /** - * Remove a header image. - * - * @since 3.4.0 - */ - final public function remove_header_image() { - $this->set_header_image( 'remove-header' ); - } - - /** - * Reset a header image to the default image for the theme. - * - * This method does not do anything if the theme does not have a default header image. - * - * @since 3.4.0 - */ - final public function reset_header_image() { - $this->process_default_headers(); - $default = get_theme_support( 'custom-header', 'default-image' ); - - if ( ! $default ) { - $this->remove_header_image(); - return; - } - $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() ); - - $default_data = array(); - foreach ( $this->default_headers as $header => $details ) { - if ( $details['url'] == $default ) { - $default_data = $details; - break; - } - } - - 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. - * - * @since 3.9.0 - * - * @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'. - * - * @since 3.9.0 - * - * @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( wp_basename( $parent_url ), wp_basename( $cropped ), $parent_url ); - - $size = @getimagesize( $cropped ); - $image_type = ( $size ) ? $size['mime'] : 'image/jpeg'; - - $object = array( - 'ID' => $parent_attachment_id, - 'post_title' => wp_basename( $cropped ), - 'post_mime_type' => $image_type, - 'guid' => $url, - 'context' => 'custom-header', - 'post_parent' => $parent_attachment_id, - ); - - return $object; - } - - /** - * Insert an attachment and its metadata. - * - * @since 3.9.0 - * - * @param array $object Attachment object. - * @param string $cropped Cropped image URL. - * @return int Attachment ID. - */ - final public function insert_attachment( $object, $cropped ) { - $parent_id = isset( $object['post_parent'] ) ? $object['post_parent'] : null; - unset( $object['post_parent'] ); - - $attachment_id = wp_insert_attachment( $object, $cropped ); - $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped ); - - // If this is a crop, save the original attachment ID as metadata. - if ( $parent_id ) { - $metadata['attachment_parent'] = $parent_id; - } - - /** - * 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. - * - * @since 3.9.0 - */ - 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 ); - - $previous = $this->get_previous_crop( $object ); - - if ( $previous ) { - $object['ID'] = $previous; - } else { - 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. - * - * @since 3.9.0 - */ - 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. - * - * @since 3.9.0 - */ - 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(); - } - - /** - * Updates the last-used postmeta on a header image attachment after saving a new header image via the Customizer. - * - * @since 3.9.0 - * - * @param WP_Customize_Manager $wp_customize Customize manager. - */ - public function customize_set_last_used( $wp_customize ) { - - $header_image_data_setting = $wp_customize->get_setting( 'header_image_data' ); - if ( ! $header_image_data_setting ) { - return; - } - $data = $header_image_data_setting->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() ); - } - - /** - * Gets the details of default header images if defined. - * - * @since 3.9.0 - * - * @return array Default header images. - */ - 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 ); - } - - /** - * Gets the previously uploaded header images. - * - * @since 3.9.0 - * - * @return array Uploaded header images. - */ - 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; - } - - /** - * Get the ID of a previous crop from the same base image. - * - * @since 4.9.0 - * - * @param array $object A crop attachment object. - * @return int|false An attachment ID if one exists. False if none. - */ - public function get_previous_crop( $object ) { - $header_images = $this->get_uploaded_header_images(); - - // Bail early if there are no header images. - if ( empty( $header_images ) ) { - return false; - } - - $previous = false; - - foreach ( $header_images as $image ) { - if ( $image['attachment_parent'] === $object['post_parent'] ) { - $previous = $image['attachment_id']; - break; - } - } - - return $previous; - } -} +/** Custom_Image_Header class */ +require_once( ABSPATH . 'wp-admin/includes/class-custom-image-header.php' ); diff --git a/wp-admin/includes/ajax-actions.php b/wp-admin/includes/ajax-actions.php index 4b91154c09..d94bb928df 100644 --- a/wp-admin/includes/ajax-actions.php +++ b/wp-admin/includes/ajax-actions.php @@ -3679,7 +3679,7 @@ function wp_ajax_crop_image() { break; } - /** This filter is documented in wp-admin/custom-header.php */ + /** This filter is documented in wp-admin/includes/class-custom-image-header.php */ $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication. $object = $wp_site_icon->create_attachment_object( $cropped, $attachment_id ); unset( $object['ID'] ); @@ -3707,7 +3707,7 @@ function wp_ajax_crop_image() { */ do_action( 'wp_ajax_crop_image_pre_save', $context, $attachment_id, $cropped ); - /** This filter is documented in wp-admin/custom-header.php */ + /** This filter is documented in wp-admin/includes/class-custom-image-header.php */ $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication. $parent_url = wp_get_attachment_url( $attachment_id ); diff --git a/wp-admin/includes/class-custom-image-header.php b/wp-admin/includes/class-custom-image-header.php new file mode 100644 index 0000000000..9a2f652331 --- /dev/null +++ b/wp-admin/includes/class-custom-image-header.php @@ -0,0 +1,1502 @@ +admin_header_callback = $admin_header_callback; + $this->admin_image_div_callback = $admin_image_div_callback; + + add_action( 'admin_menu', array( $this, 'init' ) ); + + add_action( 'customize_save_after', array( $this, 'customize_set_last_used' ) ); + add_action( 'wp_ajax_custom-header-crop', array( $this, 'ajax_header_crop' ) ); + add_action( 'wp_ajax_custom-header-add', array( $this, 'ajax_header_add' ) ); + add_action( 'wp_ajax_custom-header-remove', array( $this, 'ajax_header_remove' ) ); + } + + /** + * Set up the hooks for the Custom Header admin page. + * + * @since 2.1.0 + */ + public function init() { + $page = add_theme_page( __( 'Header' ), __( 'Header' ), 'edit_theme_options', 'custom-header', array( $this, 'admin_page' ) ); + if ( ! $page ) { + return; + } + + add_action( "admin_print_scripts-$page", array( $this, 'js_includes' ) ); + add_action( "admin_print_styles-$page", array( $this, 'css_includes' ) ); + add_action( "admin_head-$page", array( $this, 'help' ) ); + add_action( "admin_head-$page", array( $this, 'take_action' ), 50 ); + add_action( "admin_head-$page", array( $this, 'js' ), 50 ); + if ( $this->admin_header_callback ) { + add_action( "admin_head-$page", $this->admin_header_callback, 51 ); + } + } + + /** + * Adds contextual help. + * + * @since 3.0.0 + */ + public function help() { + get_current_screen()->add_help_tab( + array( + 'id' => 'overview', + 'title' => __( 'Overview' ), + 'content' => + '

' . __( 'This screen is used to customize the header section of your theme.' ) . '

' . + '

' . __( '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.' ) . '

', + ) + ); + + get_current_screen()->add_help_tab( + array( + 'id' => 'set-header-image', + 'title' => __( 'Header Image' ), + 'content' => + '

' . __( '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.' ) . '

' . + '

' . __( '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.' ) . '

' . + '

' . __( '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.' ) . '

' . + '

' . __( '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”.' ) . '

', + ) + ); + + get_current_screen()->add_help_tab( + array( + 'id' => 'set-header-text', + 'title' => __( 'Header Text' ), + 'content' => + '

' . sprintf( __( 'For most themes, the header text is your Site Title and Tagline, as defined in the General Settings section.' ), admin_url( 'options-general.php' ) ) . '

' . + '

' . __( '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.' ) . '

' . + '

' . __( 'Don’t forget to click “Save Changes” when you’re done!' ) . '

', + ) + ); + + get_current_screen()->set_help_sidebar( + '

' . __( 'For more information:' ) . '

' . + '

' . __( 'Documentation on Custom Header' ) . '

' . + '

' . __( 'Support' ) . '

' + ); + } + + /** + * Get the current step. + * + * @since 2.6.0 + * + * @return int Current step + */ + public function step() { + if ( ! isset( $_GET['step'] ) ) { + return 1; + } + + $step = (int) $_GET['step']; + if ( $step < 1 || 3 < $step || + ( 2 == $step && ! wp_verify_nonce( $_REQUEST['_wpnonce-custom-header-upload'], 'custom-header-upload' ) ) || + ( 3 == $step && ! wp_verify_nonce( $_REQUEST['_wpnonce'], 'custom-header-crop-image' ) ) + ) { + return 1; + } + + return $step; + } + + /** + * Set up the enqueue for the JavaScript files. + * + * @since 2.1.0 + */ + public function js_includes() { + $step = $this->step(); + + if ( ( 1 == $step || 3 == $step ) ) { + wp_enqueue_media(); + wp_enqueue_script( 'custom-header' ); + if ( current_theme_supports( 'custom-header', 'header-text' ) ) { + wp_enqueue_script( 'wp-color-picker' ); + } + } elseif ( 2 == $step ) { + wp_enqueue_script( 'imgareaselect' ); + } + } + + /** + * Set up the enqueue for the CSS files + * + * @since 2.7.0 + */ + public function css_includes() { + $step = $this->step(); + + if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) ) { + wp_enqueue_style( 'wp-color-picker' ); + } elseif ( 2 == $step ) { + wp_enqueue_style( 'imgareaselect' ); + } + } + + /** + * Execute custom header modification. + * + * @since 2.6.0 + */ + public function take_action() { + if ( ! current_user_can( 'edit_theme_options' ) ) { + return; + } + + if ( empty( $_POST ) ) { + return; + } + + $this->updated = true; + + if ( isset( $_POST['resetheader'] ) ) { + check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); + $this->reset_header_image(); + return; + } + + if ( isset( $_POST['removeheader'] ) ) { + check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); + $this->remove_header_image(); + return; + } + + if ( isset( $_POST['text-color'] ) && ! isset( $_POST['display-header-text'] ) ) { + check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); + set_theme_mod( 'header_textcolor', 'blank' ); + } elseif ( isset( $_POST['text-color'] ) ) { + check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); + $_POST['text-color'] = str_replace( '#', '', $_POST['text-color'] ); + $color = preg_replace( '/[^0-9a-fA-F]/', '', $_POST['text-color'] ); + if ( strlen( $color ) == 6 || strlen( $color ) == 3 ) { + set_theme_mod( 'header_textcolor', $color ); + } elseif ( ! $color ) { + set_theme_mod( 'header_textcolor', 'blank' ); + } + } + + if ( isset( $_POST['default-header'] ) ) { + check_admin_referer( 'custom-header-options', '_wpnonce-custom-header-options' ); + $this->set_header_image( $_POST['default-header'] ); + return; + } + } + + /** + * Process the default headers + * + * @since 3.0.0 + * + * @global array $_wp_default_headers + */ + public function process_default_headers() { + global $_wp_default_headers; + + if ( ! isset( $_wp_default_headers ) ) { + return; + } + + if ( ! empty( $this->default_headers ) ) { + return; + } + + $this->default_headers = $_wp_default_headers; + $template_directory_uri = get_template_directory_uri(); + $stylesheet_directory_uri = get_stylesheet_directory_uri(); + foreach ( array_keys( $this->default_headers ) as $header ) { + $this->default_headers[ $header ]['url'] = sprintf( $this->default_headers[ $header ]['url'], $template_directory_uri, $stylesheet_directory_uri ); + $this->default_headers[ $header ]['thumbnail_url'] = sprintf( $this->default_headers[ $header ]['thumbnail_url'], $template_directory_uri, $stylesheet_directory_uri ); + } + } + + /** + * Display UI for selecting one of several default headers. + * + * Show the random image option if this theme has multiple header images. + * Random image option is on by default if no header has been set. + * + * @since 3.0.0 + * + * @param string $type The header type. One of 'default' (for the Uploaded Images control) + * or 'uploaded' (for the Uploaded Images control). + */ + public function show_header_selector( $type = 'default' ) { + if ( 'default' == $type ) { + $headers = $this->default_headers; + } else { + $headers = get_uploaded_header_images(); + $type = 'uploaded'; + } + + if ( 1 < count( $headers ) ) { + echo '
'; + echo ''; + echo '
'; + } + + echo '
'; + foreach ( $headers as $header_key => $header ) { + $header_thumbnail = $header['thumbnail_url']; + $header_url = $header['url']; + $header_alt_text = empty( $header['alt_text'] ) ? '' : $header['alt_text']; + echo '
'; + echo ''; + echo '
'; + } + echo '
'; + } + + /** + * Execute JavaScript depending on step. + * + * @since 2.1.0 + */ + public function js() { + $step = $this->step(); + if ( ( 1 == $step || 3 == $step ) && current_theme_supports( 'custom-header', 'header-text' ) ) { + $this->js_1(); + } elseif ( 2 == $step ) { + $this->js_2(); + } + } + + /** + * Display JavaScript based on Step 1 and 3. + * + * @since 2.6.0 + */ + public function js_1() { + $default_color = ''; + if ( current_theme_supports( 'custom-header', 'default-text-color' ) ) { + $default_color = get_theme_support( 'custom-header', 'default-text-color' ); + if ( $default_color && false === strpos( $default_color, '#' ) ) { + $default_color = '#' . $default_color; + } + } + ?> + + + + process_default_headers(); + ?> + +
+

+ + +
+

+ Customizer.' ), + admin_url( 'customize.php?autofocus[control]=header_image' ) + ); + ?> +

+
+ + + updated ) ) { ?> +
+

Visit your site to see how it looks.' ), home_url( '/' ) ); ?>

+
+ + +

+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + default_headers ) ) : + ?> + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + +
+
+ + ' . __( 'Something went wrong.' ) . '' . + '

' . __( '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 = $url[0]; + } elseif ( isset( $_POST ) ) { + $data = $this->step_2_manage_upload(); + $attachment_id = $data['attachment_id']; + $file = $data['file']; + $url = $data['url']; + } + + if ( file_exists( $file ) ) { + list( $width, $height, $type, $attr ) = @getimagesize( $file ); + } else { + $data = wp_get_attachment_metadata( $attachment_id ); + $height = isset( $data['height'] ) ? $data['height'] : 0; + $width = isset( $data['width'] ) ? $data['width'] : 0; + unset( $data ); + } + + $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 flexible height isn't supported and the image is the exact right size + if ( ! current_theme_supports( 'custom-header', 'flex-height' ) && ! current_theme_supports( 'custom-header', 'flex-width' ) + && $width == get_theme_support( 'custom-header', 'width' ) && $height == get_theme_support( 'custom-header', 'height' ) ) { + // Add the meta-data + if ( file_exists( $file ) ) { + wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) ); + } + + $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) ); + + /** + * Fires after the header image is set or an error is returned. + * + * @since 2.1.0 + * + * @param string $file Path to the file. + * @param int $attachment_id Attachment ID. + */ + do_action( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication + + return $this->finished(); + } elseif ( $width > $max_width ) { + $oitar = $width / $max_width; + $image = wp_crop_image( $attachment_id, 0, 0, $width, $height, $max_width, $height / $oitar, false, str_replace( wp_basename( $file ), 'midsize-' . wp_basename( $file ), $file ) ); + if ( ! $image || is_wp_error( $image ) ) { + wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) ); + } + + /** This filter is documented in wp-admin/includes/class-custom-image-header.php */ + $image = apply_filters( 'wp_create_file_in_uploads', $image, $attachment_id ); // For replication + + $url = str_replace( wp_basename( $url ), wp_basename( $image ), $url ); + $width = $width / $oitar; + $height = $height / $oitar; + } else { + $oitar = 1; + } + ?> + +
+

+ +
+

+

+ +
+ +
+ + + + + + + + + + + + +

+ + +

+
+
+ false ); + + $uploaded_file = $_FILES['import']; + $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.' ) ); + } + + $file = wp_handle_upload( $uploaded_file, $overrides ); + + if ( isset( $file['error'] ) ) { + wp_die( $file['error'], __( 'Image Upload Error' ) ); + } + + $url = $file['url']; + $type = $file['type']; + $file = $file['file']; + $filename = wp_basename( $file ); + + // Construct the object array + $object = array( + 'post_title' => $filename, + 'post_content' => $url, + 'post_mime_type' => $type, + 'guid' => $url, + 'context' => 'custom-header', + ); + + // Save the data + $attachment_id = wp_insert_attachment( $object, $file ); + return compact( 'attachment_id', 'file', 'filename', 'url', 'type' ); + } + + /** + * 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. + */ + public function step_3() { + check_admin_referer( 'custom-header-crop-image' ); + + if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) { + wp_die( + '

' . __( 'Something went wrong.' ) . '

' . + '

' . __( '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( + '

' . __( 'Something went wrong.' ) . '

' . + '

' . __( 'The current theme does not support a flexible sized header image.' ) . '

', + 403 + ); + } + + if ( $_POST['oitar'] > 1 ) { + $_POST['x1'] = $_POST['x1'] * $_POST['oitar']; + $_POST['y1'] = $_POST['y1'] * $_POST['oitar']; + $_POST['width'] = $_POST['width'] * $_POST['oitar']; + $_POST['height'] = $_POST['height'] * $_POST['oitar']; + } + + $attachment_id = absint( $_POST['attachment_id'] ); + $original = get_attached_file( $attachment_id ); + + $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'], $width, $height ); + } elseif ( ! empty( $_POST['create-new-attachment'] ) ) { + $cropped = _copy_image_file( $attachment_id ); + } else { + $cropped = get_attached_file( $attachment_id ); + } + + if ( ! $cropped || is_wp_error( $cropped ) ) { + wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) ); + } + + /** This filter is documented in wp-admin/includes/class-custom-image-header.php */ + $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication + + $object = $this->create_attachment_object( $cropped, $attachment_id ); + + if ( ! empty( $_POST['create-new-attachment'] ) ) { + unset( $object['ID'] ); + } + + // Update the attachment + $attachment_id = $this->insert_attachment( $object, $cropped ); + + $url = wp_get_attachment_url( $attachment_id ); + $this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) ); + + // Cleanup. + $medium = str_replace( wp_basename( $original ), 'midsize-' . wp_basename( $original ), $original ); + if ( file_exists( $medium ) ) { + wp_delete_file( $medium ); + } + + if ( empty( $_POST['create-new-attachment'] ) && empty( $_POST['skip-cropping'] ) ) { + wp_delete_file( $original ); + } + + return $this->finished(); + } + + /** + * Display last step of custom header image page. + * + * @since 2.1.0 + */ + public function finished() { + $this->updated = true; + $this->step_1(); + } + + /** + * Display the page based on the current step. + * + * @since 2.1.0 + */ + public function admin_page() { + if ( ! current_user_can( 'edit_theme_options' ) ) { + wp_die( __( 'Sorry, you are not allowed to customize headers.' ) ); + } + $step = $this->step(); + if ( 2 == $step ) { + $this->step_2(); + } elseif ( 3 == $step ) { + $this->step_3(); + } else { + $this->step_1(); + } + } + + /** + * Unused since 3.5.0. + * + * @since 3.4.0 + * + * @param array $form_fields + * @return array $form_fields + */ + public function attachment_fields_to_edit( $form_fields ) { + return $form_fields; + } + + /** + * Unused since 3.5.0. + * + * @since 3.4.0 + * + * @param array $tabs + * @return array $tabs + */ + public function filter_upload_tabs( $tabs ) { + return $tabs; + } + + /** + * 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 attachment ID of the image). + * Or an array of arguments: attachment_id, url, width, height. All are required. + */ + final public function set_header_image( $choice ) { + if ( is_array( $choice ) || is_object( $choice ) ) { + $choice = (array) $choice; + if ( ! isset( $choice['attachment_id'] ) || ! isset( $choice['url'] ) ) { + return; + } + + $choice['url'] = esc_url_raw( $choice['url'] ); + + $header_image_data = (object) array( + 'attachment_id' => $choice['attachment_id'], + 'url' => $choice['url'], + 'thumbnail_url' => $choice['url'], + 'height' => $choice['height'], + 'width' => $choice['width'], + ); + + update_post_meta( $choice['attachment_id'], '_wp_attachment_is_custom_header', get_stylesheet() ); + set_theme_mod( 'header_image', $choice['url'] ); + set_theme_mod( 'header_image_data', $header_image_data ); + return; + } + + if ( in_array( $choice, array( 'remove-header', 'random-default-image', 'random-uploaded-image' ) ) ) { + set_theme_mod( 'header_image', $choice ); + remove_theme_mod( 'header_image_data' ); + return; + } + + $uploaded = get_uploaded_header_images(); + if ( $uploaded && isset( $uploaded[ $choice ] ) ) { + $header_image_data = $uploaded[ $choice ]; + + } else { + $this->process_default_headers(); + if ( isset( $this->default_headers[ $choice ] ) ) { + $header_image_data = $this->default_headers[ $choice ]; + } else { + return; + } + } + + set_theme_mod( 'header_image', esc_url_raw( $header_image_data['url'] ) ); + set_theme_mod( 'header_image_data', $header_image_data ); + } + + /** + * Remove a header image. + * + * @since 3.4.0 + */ + final public function remove_header_image() { + $this->set_header_image( 'remove-header' ); + } + + /** + * Reset a header image to the default image for the theme. + * + * This method does not do anything if the theme does not have a default header image. + * + * @since 3.4.0 + */ + final public function reset_header_image() { + $this->process_default_headers(); + $default = get_theme_support( 'custom-header', 'default-image' ); + + if ( ! $default ) { + $this->remove_header_image(); + return; + } + $default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() ); + + $default_data = array(); + foreach ( $this->default_headers as $header => $details ) { + if ( $details['url'] == $default ) { + $default_data = $details; + break; + } + } + + 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. + * + * @since 3.9.0 + * + * @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'. + * + * @since 3.9.0 + * + * @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( wp_basename( $parent_url ), wp_basename( $cropped ), $parent_url ); + + $size = @getimagesize( $cropped ); + $image_type = ( $size ) ? $size['mime'] : 'image/jpeg'; + + $object = array( + 'ID' => $parent_attachment_id, + 'post_title' => wp_basename( $cropped ), + 'post_mime_type' => $image_type, + 'guid' => $url, + 'context' => 'custom-header', + 'post_parent' => $parent_attachment_id, + ); + + return $object; + } + + /** + * Insert an attachment and its metadata. + * + * @since 3.9.0 + * + * @param array $object Attachment object. + * @param string $cropped Cropped image URL. + * @return int Attachment ID. + */ + final public function insert_attachment( $object, $cropped ) { + $parent_id = isset( $object['post_parent'] ) ? $object['post_parent'] : null; + unset( $object['post_parent'] ); + + $attachment_id = wp_insert_attachment( $object, $cropped ); + $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped ); + + // If this is a crop, save the original attachment ID as metadata. + if ( $parent_id ) { + $metadata['attachment_parent'] = $parent_id; + } + + /** + * 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. + * + * @since 3.9.0 + */ + 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/includes/class-custom-image-header.php */ + $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication + + $object = $this->create_attachment_object( $cropped, $attachment_id ); + + $previous = $this->get_previous_crop( $object ); + + if ( $previous ) { + $object['ID'] = $previous; + } else { + 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. + * + * @since 3.9.0 + */ + 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. + * + * @since 3.9.0 + */ + 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(); + } + + /** + * Updates the last-used postmeta on a header image attachment after saving a new header image via the Customizer. + * + * @since 3.9.0 + * + * @param WP_Customize_Manager $wp_customize Customize manager. + */ + public function customize_set_last_used( $wp_customize ) { + + $header_image_data_setting = $wp_customize->get_setting( 'header_image_data' ); + if ( ! $header_image_data_setting ) { + return; + } + $data = $header_image_data_setting->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() ); + } + + /** + * Gets the details of default header images if defined. + * + * @since 3.9.0 + * + * @return array Default header images. + */ + 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 ); + } + + /** + * Gets the previously uploaded header images. + * + * @since 3.9.0 + * + * @return array Uploaded header images. + */ + 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; + } + + /** + * Get the ID of a previous crop from the same base image. + * + * @since 4.9.0 + * + * @param array $object A crop attachment object. + * @return int|false An attachment ID if one exists. False if none. + */ + public function get_previous_crop( $object ) { + $header_images = $this->get_uploaded_header_images(); + + // Bail early if there are no header images. + if ( empty( $header_images ) ) { + return false; + } + + $previous = false; + + foreach ( $header_images as $image ) { + if ( $image['attachment_parent'] === $object['post_parent'] ) { + $previous = $image['attachment_id']; + break; + } + } + + return $previous; + } +} diff --git a/wp-includes/customize/class-wp-customize-header-image-setting.php b/wp-includes/customize/class-wp-customize-header-image-setting.php index e486e7e0b6..8aef690d93 100644 --- a/wp-includes/customize/class-wp-customize-header-image-setting.php +++ b/wp-includes/customize/class-wp-customize-header-image-setting.php @@ -31,7 +31,7 @@ final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting { // If _custom_header_background_just_in_time() fails to initialize $custom_image_header when not is_admin(). if ( empty( $custom_image_header ) ) { - require_once( ABSPATH . 'wp-admin/custom-header.php' ); + require_once( ABSPATH . 'wp-admin/includes/class-custom-image-header.php' ); $args = get_theme_support( 'custom-header' ); $admin_head_callback = isset( $args[0]['admin-head-callback'] ) ? $args[0]['admin-head-callback'] : null; $admin_preview_callback = isset( $args[0]['admin-preview-callback'] ) ? $args[0]['admin-preview-callback'] : null; diff --git a/wp-includes/theme.php b/wp-includes/theme.php index eddd76684a..0ef40bb876 100644 --- a/wp-includes/theme.php +++ b/wp-includes/theme.php @@ -2604,7 +2604,7 @@ function _custom_header_background_just_in_time() { } if ( is_admin() ) { - require_once( ABSPATH . 'wp-admin/custom-header.php' ); + require_once( ABSPATH . 'wp-admin/includes/class-custom-image-header.php' ); $custom_image_header = new Custom_Image_Header( $args[0]['admin-head-callback'], $args[0]['admin-preview-callback'] ); } } diff --git a/wp-includes/version.php b/wp-includes/version.php index 7cc2f1e42e..dff026e394 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.3-alpha-45653'; +$wp_version = '5.3-alpha-45654'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.