API16

JForm/getLabel: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 59: Line 59:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getLabel
  category=getLabel
  category=JForm
  category=JForm
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:41, 25 March 2017

Description

Method to get the label for a field.


<! removed transcluded page call, red link never existed >

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;
}


<! removed transcluded page call, red link never existed >

Examples

Code Examples