verify_file_md5

Advertisement

Summery Summery

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

Syntax Syntax

verify_file_md5( string $filename, string $expected_md5 )

Parameters Parameters

$filename

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

$expected_md5

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

Return Return

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

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 );
	} else {
		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(
			/* translators: 1: File checksum, 2: Expected checksum value. */
			__( 'The checksum of the file (%1$s) does not match the expected checksum value (%2$s).' ),
			bin2hex( $file_md5 ),
			bin2hex( $expected_raw_md5 )
		)
	);
}

Advertisement

Changelog Changelog

Changelog
Version Description
3.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.