Difference between revisions of "JRequest/getString"
From Joomla! Documentation
< API15:JRequest
(New page: ===Description===
Fetches and returns a given filtered variable. The string filter deletes 'bad' HTML code, if not overridden by the mask. This is currently only a proxy function for getV...) |
m (removing red link to edit, no existant pages) |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Syntax=== | ===Syntax=== | ||
| Line 52: | Line 52: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Examples=== | ===Examples=== | ||
| Line 67: | Line 67: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| + | [[Category:Archived pages API15]] | ||
Revision as of 13:44, 12 May 2013
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[edit]
Fetches and returns a given filtered variable. The string filter deletes 'bad' HTML code, if not overridden by the mask. This is currently only a proxy function for getVar().
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax[edit]
getString($name, $default= '', $hash= 'default', $mask=0)| 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) |
| $mask | 0 | $mask Filter mask for the variable |
Returns[edit]
string Requested variable
Defined in[edit]
libraries/joomla/environment/request.php
Importing[edit]
jimport( 'joomla.environment.request' );Source Body[edit]
function getString($name, $default = '', $hash = 'default', $mask = 0)
{
// Cast to string, in case JREQUEST_ALLOWRAW was specified for mask
return (string) JRequest::getVar($name, $default, $hash, 'string', $mask);
}[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples[edit]
<CodeExamplesForm />