Changeset 48798 for trunk/src/wp-admin/includes/image.php

Timestamp:

08/16/2020 01:31:57 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Introduce is_gd_image() to check for PHP 8 GdImage object instances.

In PHP 8, the GD extension uses GdImage objects instead of resources for its underlying data structures.

This updates the existing is_resource() calls for image resources in core to accomodate for GdImage instances as well.

Props ayeshrajans, jrf.
Fixes #50833.

File:

• trunk/src/wp-admin/includes/image.php (modified) (6 diffs)

trunk/src/wp-admin/includes/image.php

@@ -914 +914 @@
 
 /**
+ * Determines whether the value is an acceptable type for GD image functions.
+ *
+ * In PHP 8.0, the GD extension uses GdImage objects for its data structures.
+ * This function checks if the passed value is either a resource of type `gd`
+ * or a GdImage object instance. Any other type will return false.
+ *
+ * @since 5.6.0
+ *
+ * @param resource|GdImage|false $image A value to check for the type for.
+ * @return bool True if $image is either a GD image resource or GdImage instance,
+ *              false otherwise.
+ */
+function is_gd_image( $image ) {
+    if ( is_resource( $image ) && 'gd' === get_resource_type( $image )
+        || is_object( $image ) && $image instanceof GdImage
+    ) {
+        return true;
+    }
+
+    return false;
+}
+
+/**
  * Load an image resource for editing.
  *
@@ -919 +942 @@
  *
  * @param string $attachment_id Attachment ID.
- * @param string $mime_type Image mime type.
- * @param string $size Optional. Image size, defaults to 'full'.
- * @return resource|false The resulting image resource on success, false on failure.
+ * @param string $mime_type     Image mime type.
+ * @param string $size          Optional. Image size. Default 'full'.
+ * @return resource|GdImage|false The resulting image resource or GdImage instance on success,
+ *                                false on failure.
  */
 function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {
@@ -943 +967 @@
             break;
     }
-    if ( is_resource( $image ) ) {
+
+    if ( is_gd_image( $image ) ) {
         /**
          * Filters the current image being loaded for editing.
@@ -949 +974 @@
          * @since 2.9.0
          *
-         * @param resource $image         Current image.
-         * @param string   $attachment_id Attachment ID.
-         * @param string   $size          Image size.
+         * @param resource|GdImage $image         Current image.
+         * @param string           $attachment_id Attachment ID.
+         * @param string           $size          Image size.
          */
         $image = apply_filters( 'load_image_to_edit', $image, $attachment_id, $size );
+
         if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {
             imagealphablending( $image, false );
@@ -959 +985 @@
         }
     }
+
     return $image;
 }
@@ -972 +999 @@
  *
  * @param string $attachment_id Attachment ID.
- * @param string $size Optional. Image size, defaults to 'full'.
+ * @param string $size          Optional. Image size. Default 'full'.
  * @return string|false File path or url on success, false on failure.
  */