Custom_Image_Header::step_3()

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_3() 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

108–214

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

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_3()

Further down the call graph this can also reach option, cache, 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 · 216 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while Custom_Image_Header::step_3() runs, in this order:

1. 1
   apply_filters( wp_create_file_in_uploads )filterline 1078 (+62 into the body)

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

Uses · 18

• 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_crop_image()Crops an image to a given size.
• _copy_image_file()Copies an existing image file.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_copy_parent_attachment_properties()Copy parent attachment properties to newly cropped image.
• wp_get_attachment_url()Retrieves the URL for an attachment.

Used by · 1

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

Source code

View on Trac ↗View on GitHub ↗

1016	public function step_3() {1017		check_admin_referer( 'custom-header-crop-image' );1018 1019		if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {1020			wp_die(1021				'<h1>' . __( 'An error occurred while processing your header image.' ) . '</h1>' .1022				'<p>' . __( 'The active theme does not support uploading a custom header image. Please ensure your theme supports custom headers and try again.' ) . '</p>',1023				4031024			);1025		}1026 1027		if ( ! empty( $_POST['skip-cropping'] )1028			&& ! current_theme_supports( 'custom-header', 'flex-height' )1029			&& ! current_theme_supports( 'custom-header', 'flex-width' )1030		) {1031			wp_die(1032				'<h1>' . __( 'An error occurred while processing your header image.' ) . '</h1>' .1033				'<p>' . __( 'The active theme does not support a flexible sized header image.' ) . '</p>',1034				4031035			);1036		}1037 1038		if ( $_POST['oitar'] > 1 ) {1039			$_POST['x1']     = $_POST['x1'] * $_POST['oitar'];1040			$_POST['y1']     = $_POST['y1'] * $_POST['oitar'];1041			$_POST['width']  = $_POST['width'] * $_POST['oitar'];1042			$_POST['height'] = $_POST['height'] * $_POST['oitar'];1043		}1044 1045		$attachment_id = absint( $_POST['attachment_id'] );1046		$original      = get_attached_file( $attachment_id );1047 1048		$dimensions = $this->get_header_dimensions(1049			array(1050				'height' => $_POST['height'],1051				'width'  => $_POST['width'],1052			)1053		);1054		$height     = $dimensions['dst_height'];1055		$width      = $dimensions['dst_width'];1056 1057		if ( empty( $_POST['skip-cropping'] ) ) {1058			$cropped = wp_crop_image(1059				$attachment_id,1060				(int) $_POST['x1'],1061				(int) $_POST['y1'],1062				(int) $_POST['width'],1063				(int) $_POST['height'],1064				$width,1065				$height1066			);1067		} elseif ( ! empty( $_POST['create-new-attachment'] ) ) {1068			$cropped = _copy_image_file( $attachment_id );1069		} else {1070			$cropped = get_attached_file( $attachment_id );1071		}1072 1073		if ( ! $cropped || is_wp_error( $cropped ) ) {1074			wp_die( __( 'Image could not be processed. Please go back and try again.' ), __( 'Image Processing Error' ) );1075		}1076 1077		/** This filter is documented in wp-admin/includes/class-custom-image-header.php */1078		$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.1079 1080		$attachment = wp_copy_parent_attachment_properties( $cropped, $attachment_id, 'custom-header' );1081 1082		if ( ! empty( $_POST['create-new-attachment'] ) ) {1083			unset( $attachment['ID'] );1084		}1085 1086		// Update the attachment.1087		$attachment_id = $this->insert_attachment( $attachment, $cropped );1088 1089		$url = wp_get_attachment_url( $attachment_id );1090		$this->set_header_image( compact( 'url', 'attachment_id', 'width', 'height' ) );1091 1092		// Cleanup.1093		$medium = str_replace( wp_basename( $original ), 'midsize-' . wp_basename( $original ), $original );1094		if ( file_exists( $medium ) ) {1095			wp_delete_file( $medium );

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.0.4 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.