DatabaseQuery::getUniqueBindKey() method

Get a unique key to use for bind value

Note if you given a key option, it will only be used if it is determined unique, otherwise it’ll auto-generate one. When using your specified key, it is the only option that applies, unless it is not unique and the method has to auto-generate one.

Available since version 3.0.156.

Usage

// basic usage
$string = $databaseQuery->getUniqueBindKey();

// usage with all arguments
$string = $databaseQuery->getUniqueBindKey(array $options = []);

Arguments

NameType(s)Description
options (optional)array
  • key (string): Preferred bind key, or omit (blank) to auto-generate (digit only keys not accepted)
  • value (string|int): Value to use as part of the generated key
  • prefix (string): Prefix to override default
  • global (bool): Require globally unique among all instances?

Return value

string

Returns bind key/name in format ":name" (with leading colon)


DatabaseQuery methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK