ProcessModule::addReadmeFile()

Add a .md or .txt file viewable in ProcessModule

This is for adding other .md files, as README.md and CHANGELOG.md are already covered by the default handler.

Available since version 3.0.259.

Usage

$string = ProcessModule::addReadmeFile(string $moduleName, string $urlName, string $filename);

Arguments

NameType(s)Description
$moduleNamestring

Name of module readme file is for

$urlNamestring

Basename to use in URL, use something unique, not README.md or CHANGELOG.md

$filenamestring

Actual filename on server relative to given module, this doesn't have to match the given $urlName

Return value

string

Returns the URL where file can be viewed

ProcessModule methods and properties

API reference based on ProcessWire core version 3.0.259