sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.


git-svn-id: https://develop.svn.wordpress.org/trunk@31659 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-03-07 07:08:52 +00:00
parent a5fcc34a50
commit 37ca5609c8
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/wp-includes/post.php
View File

@ -5071,11 +5071,11 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) {
}
/**
* Verfify the attachment as being of a specific type
* Verifies an attachment is of a given type.
*
* @param string $type Type: image, audio, or video.
* @param int|WP_Post $post_id Optional. Default 0.
* @return bool
* @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 ) {
if ( ! $post = get_post( $post_id ) ) {
@ -5118,9 +5118,10 @@ function wp_attachment_is( $type, $post_id = 0 ) {
}
/**
* 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.
* @return bool Whether the attachment is an image.