API16:JForm/setFieldAttribute

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Method to set a field attribute value.

Syntax

setFieldAttribute($field, $attribute, $value, $group= '_default')

Parameter Name	Default Value	Description
$field		$field The name of the field.
$attribute		$attribute The name of the attribute.
$value		$value The value to set the attribute to.
$group	'_default'	$group The optional group of the field.

Returns

boolean True on success, false when field does not exist.

Defined in

libraries/joomla/form/form.php

Importing

jimport( 'joomla.form.form' );

Source Body

public function setFieldAttribute($field, $attribute, $value, $group = '_default')
{
        $return = false;
 
        // Set the field attribute if it exists.
        if (isset($this->_groups[$group][$field])) {
                if(isset($this->_groups[$group][$field]->attributes()->$attribute)) {
                        $this->_groups[$group][$field]->attributes()->$attribute = $value;
                } else {
                        $this->_groups[$group][$field]->addAttribute($attribute,$value);
                }
                $return = true;
        }
 
        return $return;
}

Examples

<CodeExamplesForm />