hash_update_file

FunctionParams and return types changed in PHP 8.0

Pump data into an active hashing context from a file.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

hash_update_file Function synopsis

hash_update_file(
    HashContext $context,
    string $filename,
    $stream_context = null
  ): bool

Parameters

$context

TypeHashContext

Hashing context returned by hash_init.

$filename

Typestring

URL describing location of file to be hashed; Supports fopen wrappers.

$stream_context

OptionalDefault valuenull

Stream context as returned by stream_context_create.

Return value

Typebool

Returns true on success, false on failure

Changes to the hash_update_file Function

PHP 8.0

  • Return type added: bool
  • Parameter type added for parameter #1 ($context): HashContext
  • Parameter type added for parameter #2 ($filename): string
  • Parameter default value added for position #3 ($stream_context): null
  hash_update_file(
-     $context,
+     HashContext $context,
-     $filename,
+     string $filename,
-     $stream_context
+     $stream_context = null
-   )
+   ): bool

PHP 7.1

  • Parameter name of parameter #3 changed: $context to $stream_context
  hash_update_file(
      $context,
      $filename,
-     $context
+     $stream_context
    )

hash_update_file Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes