wireClassName() function

Normalize a class name with or without namespace, or get namespace of class

Default behavior is to return class name without namespace.

Please note this method is and thus not intended to be called directly.

Internal usage

// basic internal usage
$string = wireClassName($className);

// internal usage with all arguments
$string = wireClassName($className, $withNamespace = false, bool $verbose = false);

Arguments

NameType(s)Description
$classNamestring object

Class name or object instance

$withNamespace (optional)bool int string

Should return value include namespace? Default:false

  • false (bool): Return only class name without namespace (default).
  • true (bool): Yes include namespace in returned value.
  • 1 (int): Return only namespace (i.e. “ProcessWire”, with no backslashes unless $verbose argument is true)
$verbose (optional)bool

When namespace argument is true or 1, use verbose return value (added 3.0.143. This does the following:

  • If returning class name with namespace, this makes it include a leading backslash, i.e. \ProcessWire\Wire
  • If returning namespace only, adds leading backslash, plus trailing backslash if namespace is not root, i.e. \ProcessWire\

Return value

string null

Returns string or NULL if namespace-only requested and unable to determine

Functions methods and properties

API reference based on ProcessWire core version 3.0.252