wpseek.com
A WordPress-centric search engine for devs and theme authors



verify_file_md5 › WordPress Function

Since3.7.0
Deprecatedn/a
› verify_file_md5 ( $filename, $expected_md5 )
Parameters: (2)
  • (string) $filename The filename to check the MD5 of.
    Required: Yes
  • (string) $expected_md5 The expected MD5 of the file, either a base64-encoded raw md5, or a hex-encoded md5.
    Required: Yes
Returns:
  • (bool|WP_Error) True on success, false when the MD5 format is unknown/unexpected, WP_Error on failure.
Defined at:
Codex:

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



Related Functions: verify_file_signature, get_file_data, wp_verify_fast_hash, wp_verify_nonce, get_filesystem_method

Source 

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 )
		)
	);
}