verify_file_md5( string $filename, string $expected_md5 )

Calculates and compares the MD5 of a file to its expected value.

Description Description

Parameters Parameters


(string) (Required) The filename to check the MD5 of.


(string) (Required) The expected MD5 of the file, either a base64 encoded raw md5, or a hex-encoded md5

Top ↑

Return Return

(bool|object) WP_Error on failure, true on success, false when the MD5 format is unknown/unexpected

Top ↑

Source Source

File: wp-admin/includes/file.php

function verify_file_md5( $filename, $expected_md5 ) {
	if ( 32 == strlen( $expected_md5 ) )
		$expected_raw_md5 = pack( 'H*', $expected_md5 );
	elseif ( 24 == strlen( $expected_md5 ) )
		$expected_raw_md5 = base64_decode( $expected_md5 );
		return false; // unknown format

	$file_md5 = md5_file( $filename, true );

	if ( $file_md5 === $expected_raw_md5 )
		return true;

	return new WP_Error( 'md5_mismatch', sprintf( __( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ), bin2hex( $file_md5 ), bin2hex( $expected_raw_md5 ) ) );

Top ↑

Changelog Changelog

Version Description
3.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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