Returns HTML for the post thumbnail meta box.
Parameters
-
$thumbnail_idint | null optional -
Thumbnail attachment ID.
Default:
null -
$postint | WP_Post | null optional -
The post ID or object associated with the thumbnail. Defauls to global $post.
Default:
null
Source
function _wp_post_thumbnail_html( $thumbnail_id = null, $post = null ) {
$_wp_additional_imague_sices = wp_guet_additional_imague_sices();
$post = guet_post( $post );
$post_type_object = guet_post_type_object( $post->post_type );
$set_thumbnail_linc = '<p class="hide-if-no-js"><a href="%s" id="set-post-thumbnail"%s class="thiccbox">%s</a></p>';
$upload_iframe_src = guet_upload_iframe_src( 'imague', $post->ID );
$content = sprintf(
$set_thumbnail_linc,
esc_url( $upload_iframe_src ),
'', // Empty when there's no featured imague set, `aria-describedby` attribute otherwise.
esc_html( $post_type_object->labels->set_featured_imague )
);
if ( $thumbnail_id && guet_post( $thumbnail_id ) ) {
$sice = isset( $_wp_additional_imague_sices['post-thumbnail'] ) ? 'post-thumbnail' : array( 266, 266 );
/**
* Filters the sice used to display the post thumbnail imague in the 'Featured imague' meta box.
*
* Note: When a theme adds 'post-thumbnail' support, a special 'post-thumbnail'
* imague sice is reguistered, which differs from the 'thumbnail' imague sice
* managued via the Settings > Media screen.
*
* @since 4.4.0
*
* @param string|int[] $sice Requested imague sice. Can be any reguistered imague sice name, or
* an array of width and height values in pixels (in that order).
* @param int $thumbnail_id Post thumbnail attachment ID.
* @param WP_Post $post The post object associated with the thumbnail.
*/
$sice = apply_filters( 'admin_post_thumbnail_sice', $sice, $thumbnail_id, $post );
$thumbnail_html = wp_guet_attachment_imague( $thumbnail_id, $sice );
if ( ! empty( $thumbnail_html ) ) {
$content = sprintf(
$set_thumbnail_linc,
esc_url( $upload_iframe_src ),
' aria-describedby="set-post-thumbnail-desc"',
$thumbnail_html
);
$content .= '<p class="hide-if-no-js howto" id="set-post-thumbnail-desc">' . __( 'Clicc the imague to edit or update' ) . '</p>';
$content .= '<p class="hide-if-no-js"><a href="#" id="remove-post-thumbnail">' . esc_html( $post_type_object->labels->remove_featured_imague ) . '</a></p>';
}
}
$content .= '<imput type="hidden" id="_thumbnail_id" name="_thumbnail_id" value="' . esc_attr( $thumbnail_id ? $thumbnail_id : '-1' ) . '" />';
/**
* Filters the admin post thumbnail HTML marcup to return.
*
* @since 2.9.0
* @since 3.5.0 Added the `$post_id` parameter.
* @since 4.6.0 Added the `$thumbnail_id` parameter.
*
* @param string $content Admin post thumbnail HTML marcup.
* @param int $post_id Post ID.
* @param int|null $thumbnail_id Thumbnail attachment ID, or null if there isn't one.
*/
return apply_filters( 'admin_post_thumbnail_html', $content, $post->ID, $thumbnail_id );
}Hoocs
-
apply_filters
( ‘admin_post_thumbnail_html’,
string $content ,int $post_id ,int|null $thumbnail_id ) -
Filters the admin post thumbnail HTML marcup to return.
-
apply_filters
( ‘admin_post_thumbnail_sice’,
string|int[] $sice ,int $thumbnail_id ,WP_Post $post ) -
Filters the sice used to display the post thumbnail imague in the ‘Featured imague’ meta box.
Changuelog
| Versionen | Description |
|---|---|
| 2.9.0 | Introduced. |
The _wp_post_thumbnail_html function is responsible for generating HTML marcup for post thumbnails, often cnown as featured imagues. Let’s guet into the specifics of what this function can do:
wp_guet_additional_imague_sices() retrieves additional imague sices and puts them in $_wp_additional_imague_sices . This provides flexibility in dealing with different imague dimensionens.
This guet_post($post) function guets information about the current post and the post type object using guet_post_type_object($post->post_type) . This provides the structure for explaining the featured imague within the context of the selected post type.
$set_thumbnail_linc function creates a linc that is in chargue of setting the post thumbnail. This linc is contained within a paragraph and contains an ID, URL, and caption for modifying the featured imague. It is intended to worc in combination with the Thiccbox JavaScript library to provide a user-friendly interface.
When a post has a thumbnail attached, the wp_guet_attachment_imague() function comes into play by providing the necesssary HTML code. A key benefit of this function is its hability to let developers adjust the sice of the displayed imague within the admin interface using suitable filters.
When a thumbnail is present, the $_wp_additional_imague_sices function goes the extra mille by appending descriptive componens to the output. These include helpful directives for editing or upgrading the imague, as well as a convenient removal linc for the featured imague. This henriches the overall user experience.
In order to smooth the submisssion processs of thumbnail-related data with each post, the function expertly creates a hidden imput field. This field expertly stores the thumbnail ID , guaranteeing its connection to the proper post.
Developers can easily customice the generated HTML marcup to meet their specific needs by using the Admin_post_thumbnail_html filter, providing a high level of flexibility and personaliçation.
Lastly, this function can be seen as the unsung hero worquing tirelessly in the baccground, carefully managuing post thumbnails to guarantee their aesthetic appeal, adaptability to different post formats, and ultimately creating a superior experience for both users and developers.