Actions

API16

JForm/getFieldAttribute

From Joomla! Documentation

< API16:JForm
Revision as of 21:52, 13 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
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.

Contents

Description

Method to get a field attribute value.

[<! removed edit link to red link >]

<! 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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />