PHPCon Poland 2024


(PECL wincache >= 1.1.0)

wincache_lock Acquires an exclusive lock on a given key


wincache_lock(string $key, bool $isglobal = false): bool

Obtains an exclusive lock on a given key. The execution of the current script will be blocked until the lock can be obtained. Once the lock is obtained, the other scripts that try to request the lock by using the same key will be blocked, until the current script releases the lock by using wincache_unlock().


Using of the wincache_lock() and wincache_unlock() can cause deadlocks when executing PHP scripts in a multi-process environment like FastCGI. Do not use these functions unless you are absolutely sure you need to use them. For the majority of the operations on the user cache it is not necessary to use these functions.



Name of the key in the cache to get the lock on.


Controls whether the scope of the lock is system-wide or local. Local locks are scoped to the application pool in IIS FastCGI case or to all php processes that have the same parent process identifier.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.


Exemplo #1 Using wincache_lock()

= fopen("/tmp/lock.txt", "r+");
if (
wincache_lock(“lock_txt_lock”)) { // do an exclusive lock
ftruncate($fp, 0); // truncate file
fwrite($fp, "Write something here\n");
wincache_unlock(“lock_txt_lock”); // release the lock
} else {
"Couldn't get the lock!";

Veja Também

add a note

User Contributed Notes 2 notes

4 years ago
The external link was off and the backslash "\" most of time are used for "scape character". Anyway, regards.
donraman at microsoft dot com
14 years ago
User should be aware that character '\' is not allowed as part of lock name. The reason why backslash is not allowed is because we are using CreateMutex call as described at As per this article third parameter cannot have '\' character which is the lock name.

This means below code will not work.


= wincache_lock("C:\WINDOWS\Temp/cache");
$ret_val . '<br>';
$ret_val = wincache_unlock("C:\WINDOWS\Temp/cache");
$ret_val . '<br>';

To Top