wppaste
WordPress

WP_REST_Attachments_Controller::get_special_image_sizes(): string[]

Since
7.1.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php:2597
Returns the image size names which name a single file rather than a sub-size.

Description

Each of these is handled on its own in self::sideload_item() and stored under its own key by self::finalize_item(), so unlike a regular sub-size none of them may appear in an array of names sharing one file.

Compatibility

WordPress
since 7.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 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Return value

string[]
Special image size names.

Performance profile

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

Executed per call on PHP 8.5. The body compiles to 7.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always7none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 7 instructions, 7 executed per call, 0 branches. The work does not change between versions.

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.

Used by · 2

Source code

View on Trac View on GitHub 

	private static function get_special_image_sizes(): array {		return array(			'original',			'scaled',			// Source-format original (e.g. the HEIC kept alongside its JPEG derivative).			self::IMAGE_SIZE_SOURCE_ORIGINAL,			// Converted-video companions for an animated GIF (the MP4/WebM and its poster).			'animated_video',			'animated_video_poster',		);	}

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.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.