View source for Developer Area/Core Subsystems/Form API (Pieforms)/Form APIElements/Help Icon

Help Icons can be added to Pieform elements by the addition of <syntaxhighlight inline lang="php">'help' => true</syntaxhighlight> to the form element array.  This will generate a help icon that will load a file via an AJAX callback.

The file name is constructed in [https://git.mahara.org/search?search=function+get_helpfile_location&nav_source=navbar&project_id=4&group_id=9&search_code=true&repository_ref=main get_helpfile_location()] and requires that the form also has <syntaxhighlight inline lang="php">pluginname</syntaxhighlight> and <syntaxhighlight inline lang="php">plugintype</syntaxhighlight> also set.

Optional: <syntaxhighlight inline lang="php">'helpinlabel' => true</syntaxhighlight> can be set to move the help icon into the label so it is close to the text of the label rather than the default location on the far right of the rendered element. This may be of use when a form has non-default layout.

Minimal example:
<syntaxhighlight lang="php">
$searchform = [
    'name' => 'exampleform',
    'plugintype' => 'core',
    'pluginname' => 'view',
    'elements' => [
        'examplecheckbox' => [
            'type' => 'checkbox',
            'class' => 'stacked',
            'title' => get_string('examplecheckboxtitle', 'view'),
            'defaultvalue' => $examplecheckbox,
            'help' => true,
            'helpinlabel' => true,
        ],
    ],
];
</syntaxhighlight>