wireClassName() function

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

Default behavior is to return class name without namespace.

Usage

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

// 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.236

Latest news

  • ProcessWire Weekly #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.