wp_get_attachment_thumb_file( int $post_id ): string|false

This function has been deprecated.

Retrieves thumbnail for an attachment.

Description

Note that this works only for the (very) old image metadata style where ‘thumb’ was set, and the ‘sizes’ array did not exist. This function returns false for the newer image metadata style despite that ‘thumbnail’ is present in the ‘sizes’ array.

Parameters

$post_idintoptional
Attachment ID. Default is the ID of the global $post.

Return

string|false Thumbnail file path on success, false on failure.

Source

function wp_get_attachment_thumb_file( $post_id = 0 ) {
	_deprecated_function( __FUNCTION__, '6.1.0' );

	$post_id = (int) $post_id;
	$post    = get_post( $post_id );

	if ( ! $post ) {
		return false;
	}

	// Use $post->ID rather than $post_id as get_post() may have used the global $post object.
	$imagedata = wp_get_attachment_metadata( $post->ID );

	if ( ! is_array( $imagedata ) ) {
		return false;
	}

	$file = get_attached_file( $post->ID );

	if ( ! empty( $imagedata['thumb'] ) ) {
		$thumbfile = str_replace( wp_basename( $file ), $imagedata['thumb'], $file );
		if ( file_exists( $thumbfile ) ) {
			/**
			 * Filters the attachment thumbnail file path.
			 *
			 * @since 2.1.0
			 *
			 * @param string $thumbfile File path to the attachment thumbnail.
			 * @param int    $post_id   Attachment ID.
			 */
			return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID );
		}
	}

	return false;
}

Hooks

apply_filters( ‘wp_get_attachment_thumb_file’, string $thumbfile, int $post_id )

Filters the attachment thumbnail file path.

Changelog

VersionDescription
6.1.0This function has been deprecated.
2.1.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.