php8.5
Home/ Manual/ stream / streamwrapper/ streamWrapper::stream_lock

streamWrapper::stream_lock

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Advisory file locking

Description

streamWrapper::stream_lock(int $operation): bool

This method is called in response to flock(), when file_put_contents() (when flags contains LOCK_EX), stream_set_blocking() and when closing the stream (LOCK_UN).

Parameters

operation

operation is one of the following:

  • LOCK_SH to acquire a shared lock (reader).
  • LOCK_EX to acquire an exclusive lock (writer).
  • LOCK_UN to release a lock (shared or exclusive).

It is also possible to have LOCK_NB added as a bitmask to one of the above operations, if the lock should not block during the locking attempt (not supported on Windows).

Return Values

Success

Errors/Exceptions

Emits E_WARNING if call to this method fails (i.e. not implemented).

See Also

Source: reference/stream/streamwrapper/stream-lock.xml · from the official PHP manual (php/doc-en)