JForm/getFieldAttribute: Difference between revisions
From Joomla! Documentation
m clean up |
m preparing for archive only |
||
| Line 59: | Line 59: | ||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=getFieldAttribute | category=getFieldAttribute | ||
category=JForm | category=JForm | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
Latest revision as of 01:41, 25 March 2017
Description
Method to get a field attribute value.
<! removed transcluded page call, red link never existed >
Syntax
getFieldAttribute($field, $attribute, $default, $group= '_default')
| Parameter Name | Default Value | Description |
|---|---|---|
| $field | $field The name of the field. | |
| $attribute | $attribute The name of the attribute. | |
| $default | $default The default value of the attribute. | |
| $group | '_default' | $group The optional group of the field. |
Returns
mixed The value of the attribute if set, otherwise the default value.
Defined in
libraries/joomla/form/form.php
Importing
jimport( 'joomla.form.form' );
Source Body
public function getFieldAttribute($field, $attribute, $default, $group = '_default')
{
$return = null;
// Get the field attribute if it exists.
if (isset($this->_groups[$group][$field])) {
$return = (string)$this->_groups[$group][$field]->attributes()->$attribute;
}
return $return !== null ? $return : $default;
}
<! removed transcluded page call, red link never existed >
Examples
Code Examples