WP_Image_Editor_GD::_save( resource|GdImage $image, string|null $filename = null, string|null $mime_type = null ): array|WP_Error

Compatibility

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

Parameters

$imageresource|GdImage

$filenamestring|nulloptional

Default: null

$mime_typestring|nulloptional

Default: null

Return value

array|WP_Error

Array on success or WP_Error if the file failed to save.

• $pathstring

  Path to the image file.

• $filestring

  Name of the image file.

• $widthint

  Image width.

• $heightint

  Image height.

• $mime-typestring

  The mime type of the image.

• $filesizeint

  File size of the image.

Performance profile

How much work a call to WP_Image_Editor_GD::_save() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

36–93

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

Plugin surface

2 hooks

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

Called by

2

2 places 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

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

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

Hooks and filters fired · 2

2 hooks fire while WP_Image_Editor_GD::_save() runs, in this order:

1. 1
   apply_filters( image_save_progressive )filterline 539 (+16 into the body)

   Filters whether to output progressive images (if available).

2. 2
   apply_filters( image_make_intermediate_size )filterline 589 (+66 into the body)

   Filters the name of the saved image file.

Uses · 9

• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• wp_basename()i18n-friendly version of basename().
• wp_filesize()Wrapper for PHP filesize with filters and casting the result as an integer.
• WP_Image_Editor_GD::get_output_format()
• WP_Image_Editor_GD::generate_filename()
• WP_Image_Editor_GD::make_image()Either calls editor's save function or handles file as a stream.
• WP_Error::__construct()Initializes the error.
• WP_Image_Editor_GD::get_quality()

Used by · 2

• WP_Image_Editor_GD::make_subsize()Create an image sub-size and return the image meta data value for it.
• WP_Image_Editor_GD::save()Saves current in-memory image to file.

Source code

View on Trac ↗View on GitHub ↗

523	protected function _save( $image, $filename = null, $mime_type = null ) {524		list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );525 526		if ( ! $filename ) {527			$filename = $this->generate_filename( null, null, $extension );528		}529 530		if ( function_exists( 'imageinterlace' ) ) {531			/**532			 * Filters whether to output progressive images (if available).533			 *534			 * @since 6.5.0535			 *536			 * @param bool   $interlace Whether to use progressive images for output if available. Default false.537			 * @param string $mime_type The mime type being saved.538			 */539			imageinterlace( $image, apply_filters( 'image_save_progressive', false, $mime_type ) );540		}541 542		if ( 'image/gif' === $mime_type ) {543			if ( ! $this->make_image( $filename, 'imagegif', array( $image, $filename ) ) ) {544				return new WP_Error( 'image_save_error', __( 'Image Editor Save Failed' ) );545			}546		} elseif ( 'image/png' === $mime_type ) {547			// Convert from full colors to index colors, like original PNG.548			if ( function_exists( 'imageistruecolor' ) && ! imageistruecolor( $image ) ) {549				imagetruecolortopalette( $image, false, imagecolorstotal( $image ) );550			}551 552			if ( ! $this->make_image( $filename, 'imagepng', array( $image, $filename ) ) ) {553				return new WP_Error( 'image_save_error', __( 'Image Editor Save Failed' ) );554			}555		} elseif ( 'image/jpeg' === $mime_type ) {556			if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->get_quality() ) ) ) {557				return new WP_Error( 'image_save_error', __( 'Image Editor Save Failed' ) );558			}559		} elseif ( 'image/webp' === $mime_type ) {560			if ( ! function_exists( 'imagewebp' )561				|| ! $this->make_image( $filename, 'imagewebp', array( $image, $filename, $this->get_quality() ) )562			) {563				return new WP_Error( 'image_save_error', __( 'Image Editor Save Failed' ) );564			}565		} elseif ( 'image/avif' === $mime_type ) {566			if ( ! function_exists( 'imageavif' )567				|| ! $this->make_image( $filename, 'imageavif', array( $image, $filename, $this->get_quality() ) )568			) {569				return new WP_Error( 'image_save_error', __( 'Image Editor Save Failed' ) );570			}571		} else {572			return new WP_Error( 'image_save_error', __( 'Image Editor Save Failed' ) );573		}574 575		// Set correct file permissions.576		$stat  = stat( dirname( $filename ) );577		$perms = $stat['mode'] & 0000666; // Same permissions as parent folder, strip off the executable bits.578		chmod( $filename, $perms );579 580		return array(581			'path'      => $filename,582			/**583			 * Filters the name of the saved image file.584			 *585			 * @since 2.6.0586			 *587			 * @param string $filename Name of the file.588			 */589			'file'      => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),590			'width'     => $this->size['width'],591			'height'    => $this->size['height'],592			'mime-type' => $mime_type,593			'filesize'  => wp_filesize( $filename ),594		);595	}

Changelog

Introduced in 3.5.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-includes/class-wp-image-editor-gd.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.