Custom_Image_Header::step_2()

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to Custom_Image_Header::step_2() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

93–244

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 336.

Plugin surface

1 hook

Third-party callbacks on 'wp_create_file_in_uploads' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly
• querycontent queryget_post()one call below Custom_Image_Header::step_2()

Further down the call graph this can also reach cache, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 304 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost Custom_Image_Header::step_2() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

2 hooks fire while Custom_Image_Header::step_2() runs, in this order:

1. 1
   apply_filters( wp_create_file_in_uploads )filterline 896 (+68 into the body)

   Filters the attachment file path after the custom header or background image is set.

2. 2
   apply_filters( wp_create_file_in_uploads )filterline 919 (+91 into the body)

   Filters the attachment file path after the custom header or background image is set.

Uses · 25

• check_admin_referer()Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
• current_theme_supports()Checks a theme's support for a given feature.
• wp_die()Kills WordPress execution and displays HTML page with an error message.
• __()Retrieves the translation of $text.
• absint()Converts a value to non-negative integer.
• get_attached_file()Retrieves attached file path based on attachment ID.
• wp_get_attachment_image_src()Retrieves an image to represent an attachment.
• wp_getimagesize()Allows PHP's getimagesize() to be debuggable when necessary.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• get_theme_support()Gets the theme support arguments passed when registering that support.
• wp_update_attachment_metadata()Updates metadata for an attachment.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.

Used by · 1

• Custom_Image_Header::admin_page()Displays the page based on the current step.

Source code

View on Trac ↗View on GitHub ↗

828	public function step_2() {829		check_admin_referer( 'custom-header-upload', '_wpnonce-custom-header-upload' );830 831		if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {832			wp_die(833				'<h1>' . __( 'An error occurred while processing your header image.' ) . '</h1>' .834				'<p>' . __( 'The active theme does not support uploading a custom header image. Please ensure your theme supports custom headers and try again.' ) . '</p>',835				403836			);837		}838 839		if ( empty( $_POST ) && isset( $_GET['file'] ) ) {840			$attachment_id = absint( $_GET['file'] );841			$file          = get_attached_file( $attachment_id, true );842			$url           = wp_get_attachment_image_src( $attachment_id, 'full' );843			$url           = $url[0];844		} elseif ( isset( $_POST ) ) {845			$data          = $this->step_2_manage_upload();846			$attachment_id = $data['attachment_id'];847			$file          = $data['file'];848			$url           = $data['url'];849		}850 851		if ( file_exists( $file ) ) {852			list( $width, $height, $type, $attr ) = wp_getimagesize( $file );853		} else {854			$data   = wp_get_attachment_metadata( $attachment_id );855			$height = isset( $data['height'] ) ? (int) $data['height'] : 0;856			$width  = isset( $data['width'] ) ? (int) $data['width'] : 0;857			unset( $data );858		}859 860		$max_width = 0;861 862		// For flex, limit size of image displayed to 1500px unless theme says otherwise.863		if ( current_theme_supports( 'custom-header', 'flex-width' ) ) {864			$max_width = 1500;865		}866 867		if ( current_theme_supports( 'custom-header', 'max-width' ) ) {868			$max_width = max( $max_width, get_theme_support( 'custom-header', 'max-width' ) );869		}870 871		$max_width = max( $max_width, get_theme_support( 'custom-header', 'width' ) );872 873		// If flexible height isn't supported and the image is the exact right size.874		if ( ! current_theme_supports( 'custom-header', 'flex-height' )875			&& ! current_theme_supports( 'custom-header', 'flex-width' )876			&& (int) get_theme_support( 'custom-header', 'width' ) === $width877			&& (int) get_theme_support( 'custom-header', 'height' ) === $height878		) {879			// Add the metadata.880			if ( file_exists( $file ) ) {881				wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );882			}883 884			$this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );885 886			/**887			 * Filters the attachment file path after the custom header or background image is set.888			 *889			 * Used for file replication.890			 *891			 * @since 2.1.0892			 *893			 * @param string $file          Path to the file.894			 * @param int    $attachment_id Attachment ID.895			 */896			$file = apply_filters( 'wp_create_file_in_uploads', $file, $attachment_id ); // For replication.897 898			return $this->finished();899		} elseif ( $width > $max_width ) {900			$oitar = $width / $max_width;901 902			$image = wp_crop_image(903				$attachment_id,904				0,905				0,906				$width,907				$height,

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-custom-image-header.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.