wp_load_image( string $file ): resource|GdImage|string
- Since
- 2.1.0
- Source
wp-includes/deprecated.php:3197
Compatibility
Deprecated in WordPress 3.5.0. Use wp_get_image_editor()
- WordPress
- since 2.1.0
- PHP
- 7.4–8.6-dev
- 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), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$filestring- Filename of the image to load.
Return value
resource|GdImage|string- The resulting image resource or GdImage instance on success, error string on failure.
Performance profile
How much work a call to wp_load_image() 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
- Scaling
- Constant
- Instructions
- 20–42
- Plugin surface
- None
- Called by
- 0
Reads or writes the filesystem via is_file().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 55.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- filesystemfilesystem access
is_file()called directly - hookthird-party callbacks
do_action()one call below wp_load_image()
Further down the call graph this can also reach cache, serialize, option, query 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 · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_load_image() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$file && is_file() && !function_exists() | 20 | _deprecated_function(), is_file(), function_exists(), __() |
!$file && !is_file() | 20 | _deprecated_function(), is_file(), __(), sprintf() |
$file && is_file() && !function_exists() | 24 | _deprecated_function(), get_attached_file(), is_file(), function_exists(), __() |
$file && !is_file() | 24 | _deprecated_function(), get_attached_file(), is_file(), __(), sprintf() |
!$file && is_file() && function_exists() && is_gd_image() | 31 | _deprecated_function(), is_file(), function_exists(), wp_raise_memory_limit(), file_get_contents(), imagecreatefromstring(), is_gd_image() |
$file && is_file() && function_exists() && is_gd_image() | 35 | _deprecated_function(), get_attached_file(), is_file(), function_exists(), wp_raise_memory_limit(), file_get_contents(), imagecreatefromstring(), is_gd_image() |
!$file && is_file() && function_exists() && !is_gd_image() | 38 | _deprecated_function(), is_file(), function_exists(), wp_raise_memory_limit(), file_get_contents(), imagecreatefromstring(), is_gd_image(), __(), sprintf() |
$file && is_file() && function_exists() && !is_gd_image() | 42 | _deprecated_function(), get_attached_file(), is_file(), function_exists(), wp_raise_memory_limit(), file_get_contents(), imagecreatefromstring(), is_gd_image(), __(), sprintf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 55 | 20–42 | 4 | |
| 8.5 | 55 | 20–42 | 4 | |
| 8.4 | 55 | 20–42 | 4 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 57 | 22–44 | 4 | |
| 8.2 | 57 | 22–44 | 4 | |
| 8.1 | 57 | 22–44 | 4 | |
| 7.4 | 57 | 22–44 | 4 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 5
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- get_attached_file()Retrieves attached file path based on attachment ID.
- __()Retrieves the translation of $text.
- wp_raise_memory_limit()Attempts to raise the PHP memory limit for memory intensive processes.
- is_gd_image()Determines whether the value is an acceptable type for GD image functions.
Source code
function wp_load_image( $file ) { _deprecated_function( __FUNCTION__, '3.5.0', 'wp_get_image_editor()' ); if ( is_numeric( $file ) ) $file = get_attached_file( $file ); if ( ! is_file( $file ) ) { /* translators: %s: File name. */ return sprintf( __( 'File “%s” does not exist?' ), $file ); } if ( ! function_exists('imagecreatefromstring') ) return __('The GD image library is not installed.'); // Set artificially high because GD uses uncompressed images in memory. wp_raise_memory_limit( 'image' ); $image = imagecreatefromstring( file_get_contents( $file ) ); if ( ! is_gd_image( $image ) ) { /* translators: %s: File name. */ return sprintf( __( 'File “%s” is not an image.' ), $file ); } return $image;}Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/deprecated.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.