Changeset 56122

Timestamp:

07/01/2023 11:08:43 PM (15 months ago)

Author:

audrasjb

Message:

Docs: Fix image_get_intermediate_size() docblock.

The description of returned values in array was incorrect for image_get_intermediate_size():

• $file returns the filename of image, no path information
• $path returns path relative to the uploads directory, not absolute

Props crstauf, sccr410.
Fixes #58686.
See #57840.

File:

• trunk/src/wp-includes/media.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -750 +750 @@
  *     path and URL if registered size is passed to `$size` parameter. False on failure.
  *
- *     @type string $file   Path of image relative to uploads directory.
+ *     @type string $file   Filename of image.
  *     @type int    $width  Width of image in pixels.
  *     @type int    $height Height of image in pixels.
- *     @type string $path   Absolute filesystem path of image.
+ *     @type string $path   Path of image relative to uploads directory.
  *     @type string $url    URL of image.
  * }