WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Attachments_Controller::get_attachment_filesize()

WP_REST_Attachments_Controller::get_attachment_filesize( int $attachment_id ): int|null

In this article

Back to top

Gets the attachment’s file size in bytes.

Parameters

$attachment_idintrequired
Attachment ID.

Return

int|null Attachment file size in bytes, or null if not available.

Source

protected function get_attachment_filesize( int $attachment_id ): ?int {
	$meta = wp_get_attachment_metadata( $attachment_id );

	if ( isset( $meta['filesize'] ) ) {
		return $meta['filesize'];
	}

	$original_path = wp_get_original_image_path( $attachment_id );
	$attached_file = $original_path ? $original_path : get_attached_file( $attachment_id );

	if ( is_string( $attached_file ) && is_readable( $attached_file ) ) {
		return wp_filesize( $attached_file );
	}

	return null;
}

View all references View on Trac View on GitHub

UsesDescription
wp_filesize()wp-includes/functions.php

Wrapper for PHP filesize with filters and casting the result as an integer.

wp_get_original_image_path()wp-includes/post.php

Retrieves the path to an uploaded image file.

wp_get_attachment_metadata()wp-includes/post.php

Retrieves attachment metadata for attachment ID.

get_attached_file()wp-includes/post.php

Retrieves attached file path based on attachment ID.

Used byDescription
WP_REST_Attachments_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Prepares a single attachment output for response.

Changelog

VersionDescription
7.0.0Introduced.

User Contributed Notes

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