wppaste
WordPress

WP_Image_Editor::save( string $destfilename = null, string $mime_type = null ): array|WP_Error

Since
3.5.0, 6.0.0
Source
wp-includes/class-wp-image-editor.php:93
Saves current image to file.

Compatibility

WordPress
since 6.0.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$destfilenamestringoptional
Destination filename. Default null.Default: null
$mime_typestringoptional
The mime-type. Default null.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::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.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

Source code

View on Trac View on GitHub 

	abstract public function save( $destfilename = null, $mime_type = null );

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.

6.0.0
The $filesize value was added to the returned array.from the docblock
3.5.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/class-wp-image-editor.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.