API16:JForm/setField

Description

Method to replace a field in a group.

Syntax

setField(&$field, $group= '_default')

Parameter Name	Default Value	Description
&$field		$field The field object to replace.
$group	'_default'	$group The group to replace the field in.

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 setField(&$field, $group = '_default')
{
        $return = false;

        // Add the fields to the group if it exists.
        if (isset($this->_groups[$group][$field->attributes()->name])) {
                $this->_groups[$group][(string)$field->attributes()->name] = $field;
                $return = true;
        }

        return $return;
}

Examples

<CodeExamplesForm />