flock

FunctionParams and return types changed in PHP 8.0

Portable advisory file locking.

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

flock Function synopsis

flock(
    $stream,
    int $operation,
    &$would_block = null
  ): bool

Parameters

$stream
$operation

Typeint

$operation is one of the following:

$would_block

Passed by reference, OptionalDefault valuenull

The optional third argument is set to 1 if the lock would block (EWOULDBLOCK errno condition).

Note that the parameter $would_block is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typebool

Returns true on success, false on failure

Changes to the flock Function

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #1 changed: $fp to $stream
  • Parameter type added for parameter #2 ($operation): int
  • Parameter name of parameter #3 changed: $wouldblock to $would_block
  • Parameter default value added for position #3 ($would_block): null
  flock(
-     $fp,
+     $stream,
-     $operation,
+     int $operation,
-     &$wouldblock
+     &$would_block = null
-   )
+   ): bool

flock 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