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.244

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer