$wire→docs()
Get ProcessWire API docs (WireApiDocs class instance)
Docs can also be accessed from the CLI. Use php index.php docs to list all available options.
Below are brief examples but please see the WireApiDocs class for all options
and methods. Note that if your argument value to the $wire->docs->get()
method is a string, it returns a string. If it's an array, it returns an array.
Available since version 3.0.264.
Example
// get summary array of all available API docs
$array = $wire->docs->get();
// get API docs for specific class (string, markdown)
$markdown = $wire->docs->get('Pages');
// get API docs for multiple classes
$array = $wire->docs->get(['Pages', 'Fields', 'Templates' ]);
// Find docs available for all classes starting with 'Fieldtype'
$array = $wire->docs->get([ 'Fieldtype*' ]);Usage
$wireApiDocs = $wire->docs();Return value
API reference based on ProcessWire core version 3.0.264