API16

JForm/setField

< API16:JForm

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Method to replace a field in a group.


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

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


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

Examples

Code Examples


Advertisement