W3cubDocs

/WordPress

Custom_Background::handle_upload()

Handle an Image upload for the background image.

Source

File: wp-admin/includes/class-custom-background.php 

public function handle_upload() {
		if ( empty( $_FILES ) ) {
			return;
		}

		check_admin_referer( 'custom-background-upload', '_wpnonce-custom-background-upload' );
		$overrides = array( 'test_form' => 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'] );
		}

		$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-background',
		);

		// Save the data.
		$id = wp_insert_attachment( $object, $file );

		// Add the metadata.
		wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
		update_post_meta( $id, '_wp_attachment_is_custom_background', get_option( 'stylesheet' ) );

		set_theme_mod( 'background_image', esc_url_raw( $url ) );

		$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/includes/class-custom-image-header.php */
		do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication.
		$this->updated = true;
	}

Uses

Uses Description
wp-admin/includes/image.php: wp_generate_attachment_metadata()

Generate attachment meta data and create image sub-sizes for images.
wp-admin/includes/file.php: wp_handle_upload()

Wrapper for _wp_handle_upload().
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: set_theme_mod()

Updates theme modification value for the current theme.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: wp_basename()

i18n friendly version of basename()
wp-includes/formatting.php: esc_url_raw()

Performs esc_url() for database usage.
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: wp_check_filetype_and_ext()

Attempt to determine the real file type of a file.
wp-includes/functions.php: wp_die()

Kills WordPress execution and displays HTML page with an error message.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/media.php: wp_get_attachment_image_src()

Retrieves an image to represent an attachment.
wp-includes/post.php: wp_insert_attachment()

Insert an attachment.
wp-includes/post.php: wp_update_attachment_metadata()

Updates metadata for an attachment.
wp-includes/post.php: wp_match_mime_types()

Check a MIME-Type against a list.
wp-includes/post.php: update_post_meta()

Updates a post meta field based on the given post ID.

Changelog

Version Description
3.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/custom_background/handle_upload