Changeset 14981 for trunk/wp-includes/media.php

Timestamp:

05/27/2010 05:03:46 AM (15 years ago)

Author:

nacin

Message:

Add some educational tips. Suggest using add_image_size() in the inline docs for image_get_intermediate_size() and wp_get_attachment_image(). props jorbin. see #13556.

File:

• trunk/wp-includes/media.php (modified) (2 diffs)

trunk/wp-includes/media.php

@@ -485 +485 @@
  * The url path will be given, when the $size parameter is a string.
  *
- * @since 2.5.0
+ * If you are passing an array for the $size, you should consider using
+ * add_image_size() so that a cropped version is generated. It's much more
+ * efficient than having to find the closest-sized image and then having the
+ * browser scale down the image.
+ *
+ * @since 2.5.0
+ * @see add_image_size()
  *
  * @param int $post_id Attachment ID for image.
@@ -588 +594 @@
  * Get an HTML img element representing an image attachment
  *
+ * While $size will accept an array, it is better to register a size with
+ * add_image_size() so that a cropped version is generated. It's much more
+ * efficient than having to find the closest-sized image and then having the
+ * browser scale down the image.
+ *
+ * @see add_image_size()
  * @uses apply_filters() Calls 'wp_get_attachment_image_attributes' hook on attributes array
  * @uses wp_get_attachment_image_src() Gets attachment file URL and dimensions