Jump to main content Jump to doc navigation

modResource.getLock

Reads one message from the locks registry without removing it and returns the user ID stored there. The registry is subscribed per Resource, so only this Resource's lock is read.

Returns 0 for a free lock, outside modX, or when the registry service cannot be loaded.

Syntax

integer getLock ()

Example

$resource = $modx->getObject('modResource', array('id' => 5));
$lockedBy = $resource->getLock();
if ($lockedBy) {
    echo 'locked by user ' . $lockedBy;
}

See Also

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

  • modmore
  • STERC
  • Digital Penguin
  • Jens Wittmann – Gestaltung & Entwicklung
  • CrewMark
  • Fabian Christen
  • Sepia River Studios
  • Dannevang Digital
  • Alex
  • A. Moreno
  • Chris Fickling
  • Stéphane Jäggi
  • Murray Wood
  • Anton Tarasov
  • JT Skaggs
  • deJaya
  • Lefthandmedia
  • eydolan
  • Following Sea
  • Guido Gallenkamp
  • YJ
  • Raffy
  • Snow Creative
  • Nick Clark
  • Guest
  • Helen
  • krisznet
  • Yanni
  • Richard

Budget

$194 per month—let's make that $500!

Learn more