Custom_Image_Header::step_3() WordPress Method

The Custom_Image_Header::step_3() method is responsible for displaying the final form for setting up a custom image header. This is the last step in the process, and it allows the user to select an image and crop it to their liking. Once the image is selected, the user can then click the "Save Changes" button to save their settings.

Custom_Image_Header::step_3() #

Display third step of custom header image page.

Source
Related
- Uses
- Used By
Changelog

Source

File: wp-admin/includes/class-custom-image-header.php

public function step_3() {
    check_admin_referer( 'custom-header-crop-image' );
 
    if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {
        wp_die(
            '<h1>' . __( 'Something went wrong.' ) . '</h1>' .
            '<p>' . __( 'The active theme does not support uploading a custom header image.' ) . '</p>',
            403
        );
    }
 
    if ( ! empty( $_POST['skip-cropping'] )
        && ! current_theme_supports( 'custom-header', 'flex-height' )
        && ! current_theme_supports( 'custom-header', 'flex-width' )
    ) {
        wp_die(
            '<h1>' . __( 'Something went wrong.' ) . '</h1>' .
            '<p>' . __( 'The active theme does not support a flexible sized header image.' ) . '</p>',
            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.
 
    $attachment = $this->create_attachment_object( $cropped, $attachment_id );
 
    if ( ! empty( $_POST['create-new-attachment'] ) ) {
        unset( $attachment['ID'] );
    }
 
    // Update the attachment.
    $attachment_id = $this->insert_attachment( $attachment, $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();
}

Expand full source code Collapse full source codeView on TracView on GitHub

Top ↑

Uses

Uses
Uses	Description
wp-includes/functions.php:wp_delete_file()	Delete a file
wp-admin/includes/image.php:_copy_image_file()	Copy an existing image file.
wp-admin/includes/image.php:wp_crop_image()	Crops an image to a given size.
wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::get_header_dimensions()	Calculate width and height based on what the currently selected theme supports.
wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::create_attachment_object()	Create an attachment ‘object’.
wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::insert_attachment()	Insert an attachment and its metadata.
wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::set_header_image()	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).
wp-admin/includes/class-custom-image-header.php:Custom_Image_Header::finished()	Display last step of custom header image page.
wp-admin/includes/class-custom-image-header.php:wp_create_file_in_uploads	Fires after the header image is set or an error is returned.
wp-includes/theme.php:current_theme_supports()	Checks a theme’s support for a given feature.
wp-includes/l10n.php:__()	Retrieve the translation of $text.
wp-includes/formatting.php:wp_basename()	i18n-friendly version of basename().
wp-includes/pluggable.php:check_admin_referer()	Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
wp-includes/functions.php:absint()	Convert a value to non-negative integer.
wp-includes/functions.php:wp_die()	Kills WordPress execution and displays HTML page with an error message.
wp-includes/plugin.php:apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/post.php:wp_get_attachment_url()	Retrieve the URL for an attachment.
wp-includes/post.php:get_attached_file()	Retrieve attached file path based on attachment ID.
wp-includes/load.php:is_wp_error()	Checks whether the given variable is a WordPress Error.