WireApiDocs
Provides methods for retrieving API.md documentation
The methods of this class can be accessed from $wire->docs()->...
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Wire class also inherits all the methods and properties of: Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
Wire Wire Wire | array string | Get API docs | |
Wire Wire Wire | None | Get a chapter body/text from the given chapter index or title | |
Wire Wire Wire | array | Get chapters for one class | |
Wire Wire Wire | array | Same as get() method but with verbose array return value |
Advanced
| Name | Return | Summary | |
|---|---|---|---|
Wire Wire Wire | array | Get or set API file names Default:['API.md'] | |
Wire Wire Wire | array | Get or set paths to scan for API files | |
Wire Wire Wire | array | Get or set directory names to exclude (can also include regex patterns of dir names) | |
Wire Wire Wire | array | Get list of API docs in alternate array format (for AgentTools) | |
Wire Wire Wire | None | Reset/clear all persistent caches |
Additional methods and properties
In addition to the methods and properties above, Wire
API reference based on ProcessWire core version 3.0.264