API16:JForm/getLabel
From Joomla! Documentation
Contents |
Description
Method to get the label for a field.
Syntax
getLabel($name, $group= '_default', $formControl= '_default', $groupControl= '_default', $value=null)
| Parameter Name | Default Value | Description |
|---|---|---|
| $name | $name The field name. | |
| $group | '_default' | $group The group the field is in. |
| $formControl | '_default' | $formControl The optional form control. Set to false to disable. |
| $groupControl | '_default' | $groupControl The optional group control. Set to false to disable. |
| $value | null | $value The optional value to render as the default for the field. |
Returns
string The form field label.
Defined in
libraries/joomla/form/form.php
Importing
jimport( 'joomla.form.form' );
Source Body
public function getLabel($name, $group = '_default', $formControl = '_default', $groupControl = '_default', $value = null) { // Render the field label. $field = $this->getField($name, $group, $formControl, $groupControl, $value); $label = $field->label; return $label; }
[Edit See Also] SeeAlso:JForm/getLabel