Changeset 31659

Timestamp:

03/07/2015 07:08:52 AM (10 years ago)

Author:

DrewAPicture

Message:

Better document parameters and the return for the newly-introduced wp_attachment_is().

Also adds a changelog entry to the DocBlock for wp_attachment_is_image() to denote that it serves as a wrapper for wp_attachment_is() as of 4.2.0.

See [31645]. See #25275.

File:

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

trunk/src/wp-includes/post.php

@@ -5072 +5072 @@
 
 /**
- * Verfify the attachment as being of a specific type
- *
- * @param string      $type    Type: image, audio, or video.
- * @param int|WP_Post $post_id Optional. Default 0.
- * @return bool
+ * Verifies an attachment is of a given type.
+ *
+ * @param string      $type    Attachment type. Accepts 'image', 'audio', or 'video'.
+ * @param int|WP_Post $post_id Optional. Attachment ID. Default 0.
+ * @return bool True if one of the accepted types, false otherwise.
  */
 function wp_attachment_is( $type, $post_id = 0 ) {
@@ -5119 +5119 @@
 
 /**
- * Check if the attachment is an image.
+ * Checks if the attachment is an image.
  *
  * @since 2.1.0
+ * @since 4.2.0 Modified into wrapper for wp_attachment_is()
  *
  * @param int|WP_Post $post Optional. Attachment ID. Default 0.