Question

_wp_post_thumbnail_html( int $thumbnail_id = null,  mixed $post = null )

Output HTML for the post thumbnail meta-box.

---

description

---

参数

$thumbnail_id

(int) (Optional) ID of the attachment used for thumbnail

Default value: null

$post

(mixed) (Optional) The post ID or object associated with the thumbnail, defaults to global $post.

Default value: null

---

返回值

(string) html

---

源代码

File: wp-admin/includes/post.php

function _wp_post_thumbnail_html( $thumbnail_id = null, $post = null ) {
	$_wp_additional_image_sizes = wp_get_additional_image_sizes();

	$post               = get_post( $post );
	$post_type_object   = get_post_type_object( $post->post_type );
	$set_thumbnail_link = '<p class="hide-if-no-js"><a href="%s" id="set-post-thumbnail"%s class="thickbox">%s</a></p>';
	$upload_iframe_src  = get_upload_iframe_src( 'image', $post->ID );

	$content = sprintf( $set_thumbnail_link,
		esc_url( $upload_iframe_src ),
		'', // Empty when there's no featured image set, `aria-describedby` attribute otherwise.
		esc_html( $post_type_object->labels->set_featured_image )
	);

	if ( $thumbnail_id && get_post( $thumbnail_id ) ) {
		$size = isset( $_wp_additional_image_sizes['post-thumbnail'] ) ? 'post-thumbnail' : array( 266, 266 );

		/**
		 * Filters the size used to display the post thumbnail image in the 'Featured Image' meta box.
		 *
		 * Note: When a theme adds 'post-thumbnail' support, a special 'post-thumbnail'
		 * image size is registered, which differs from the 'thumbnail' image size
		 * managed via the Settings > Media screen. See the `$size` parameter description
		 * for more information on default values.
		 *
		 * @since 4.4.0
		 *
		 * @param string|array $size         Post thumbnail image size to display in the meta box. Accepts any valid
		 *                                   image size, or an array of width and height values in pixels (in that order).
		 *                                   If the 'post-thumbnail' size is set, default is 'post-thumbnail'. Otherwise,
		 *                                   default is an array with 266 as both the height and width values.
		 * @param int          $thumbnail_id Post thumbnail attachment ID.
		 * @param WP_Post      $post         The post object associated with the thumbnail.
		 */
		$size = apply_filters( 'admin_post_thumbnail_size', $size, $thumbnail_id, $post );

		$thumbnail_html = wp_get_attachment_image( $thumbnail_id, $size );

		if ( ! empty( $thumbnail_html ) ) {
			$content = sprintf( $set_thumbnail_link,
				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">' . __( 'Click the image 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_image ) . '</a></p>';
		}
	}

	$content .= '<input type="hidden" id="_thumbnail_id" name="_thumbnail_id" value="' . esc_attr( $thumbnail_id ? $thumbnail_id : '-1' ) . '" />';

	/**
	 * Filters the admin post thumbnail HTML markup 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 markup.
	 * @param int    $post_id      Post ID.
	 * @param int    $thumbnail_id Thumbnail ID.
	 */
	return apply_filters( 'admin_post_thumbnail_html', $content, $post->ID, $thumbnail_id );
}

---

更新日志

Version	description
2.9.0	Introduced.

---

相关函数

Uses

• wp-includes/media.php: wp_get_additional_image_sizes()
• wp-admin/includes/post.php: admin_post_thumbnail_size
• wp-admin/includes/media.php: get_upload_iframe_src()
• wp-admin/includes/post.php: admin_post_thumbnail_html
• wp-includes/l10n.php: __()
• wp-includes/formatting.php: esc_url()
• wp-includes/formatting.php: esc_html()
• wp-includes/formatting.php: esc_attr()
• wp-includes/plugin.php: apply_filters()
• wp-includes/media.php: wp_get_attachment_image()
• wp-includes/post.php: get_post()
• wp-includes/post.php: get_post_type_object()
Show 7 more uses Hide more uses

---

Used By

• wp-admin/includes/ajax-actions.php: wp_ajax_get_post_thumbnail_html()
• wp-admin/includes/ajax-actions.php: wp_ajax_set_post_thumbnail()
• wp-admin/includes/meta-boxes.php: post_thumbnail_meta_box()

---

User Contributed Notes