JRequest/getBool: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Fetches and returns a given filtered variable. The bool filter will only return true/false bool values. This is currently only a proxy function for getVar().
<span cla... |
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 47: | Line 47: | ||
<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 62: | Line 62: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API15]] | |||
Revision as of 18:44, 12 May 2013
Description
Fetches and returns a given filtered variable. The bool filter will only return true/false bool values. This is currently only a proxy function for getVar().
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax
getBool($name, $default=false, $hash= 'default')
| Parameter Name | Default Value | Description |
|---|---|---|
| $name | $name Variable name | |
| $default | false | $default Default value if the variable does not exist |
| $hash | 'default' | $hash Where the var should come from (POST, GET, FILES, COOKIE, METHOD) |
Returns
bool Requested variable
Defined in
libraries/joomla/environment/request.php
Importing
jimport( 'joomla.environment.request' );
Source Body
function getBool($name, $default = false, $hash = 'default')
{
return JRequest::getVar($name, $default, $hash, 'bool');
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />