wp_filesize( string $path ): int

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

Parameters

$pathstringrequired
Path to the file.

Return

int The size of the file in bytes, or 0 in the event of an error.

Source

function wp_filesize( $path ) {
	/**
	 * Filters the result of wp_filesize before the PHP function is run.
	 *
	 * @since 6.0.0
	 *
	 * @param null|int $size The unfiltered value. Returning an int from the callback bypasses the filesize call.
	 * @param string   $path Path to the file.
	 */
	$size = apply_filters( 'pre_wp_filesize', null, $path );

	if ( is_int( $size ) ) {
		return $size;
	}

	$size = file_exists( $path ) ? (int) filesize( $path ) : 0;

	/**
	 * Filters the size of the file.
	 *
	 * @since 6.0.0
	 *
	 * @param int    $size The result of PHP filesize on the file.
	 * @param string $path Path to the file.
	 */
	return (int) apply_filters( 'wp_filesize', $size, $path );
}

Hooks

apply_filters( ‘pre_wp_filesize’, null|int $size, string $path )

Filters the result of wp_filesize before the PHP function is run.

apply_filters( ‘wp_filesize’, int $size, string $path )

Filters the size of the file.

Changelog

VersionDescription
6.0.0Introduced.

User Contributed Notes

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