Joomla! Documentation™

The "API15" 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

Fetches and returns a given filtered variable. The word filter only allows the characters [A-Za-z_]. This is currently only a proxy function for getVar().

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

Syntax

getWord($name, $default= '', $hash= 'default')

Parameter Name	Default Value	Description
$name		$name Variable name
$default		$default Default value if the variable does not exist
$hash	'default'	$hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD)

Returns

string Requested variable

Defined in

libraries/joomla/environment/request.php

Importing

jimport( 'joomla.environment.request' );

Source Body

function getWord($name, $default = '', $hash = 'default')
{
        return JRequest::getVar($name, $default, $hash, 'word');
}

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

Examples

<CodeExamplesForm />