set_post_thumbnail() WordPress Function
The set_post_thumbnail() function is used to set a post's thumbnail image. This function takes two parameters: the post ID and the thumbnail image ID. The post ID is the ID of the post for which you want to set the thumbnail image. The thumbnail image ID is the ID of the image you want to use as the thumbnail image.
set_post_thumbnail( int|WP_Post $post, int $thumbnail_id ) #
Sets the post thumbnail (featured image) for the given post.
Parameters
- $post
(int|WP_Post)(Required)Post ID or post object where thumbnail should be attached.
- $thumbnail_id
(int)(Required)Thumbnail to attach.
Return
(int|bool) True on success, false on failure.
Source
File: wp-includes/post.php
7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 | function set_post_thumbnail( $post, $thumbnail_id ) { $post = get_post( $post ); $thumbnail_id = absint( $thumbnail_id ); if ( $post && $thumbnail_id && get_post( $thumbnail_id ) ) { if ( wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) ) { return update_post_meta( $post->ID, '_thumbnail_id', $thumbnail_id ); } else { return delete_post_meta( $post->ID, '_thumbnail_id' ); } } return false;} |
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |