Difference between revisions of "JFilterInput::clean"

Latest revision as of 22:02, 24 March 2017

The "API17" 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.

JFilterInput::clean[edit]

Description[edit]

Method to be called by another php script. Processes for XSS and specified bad code.

public function clean (
        $source
        $type='string'
)

Parameter	Type	Default	Description
$source
$type		'string'

Returns
Defined on line 131 of libraries/joomla/filter/filterinput.php

User contributed notes[edit]

Code Examples[edit]

@@ Line 2: / Line 2: @@
 =={{JVer|11.1}} JFilterInput::clean==
 ===Description===
-Method to be called by another php script.
+Method to be called by another php script. Processes for XSS and specified bad code.
-{{Description:JFilterInput::clean}}
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[Description:JFilterInput::clean|Edit Descripton]]<nowiki>]</nowiki>
-</span>
-===Synopsis===
 <source lang="php">
-public  JFilterInput->clean ($source, $type='string')
+public function clean (
+        $source
+        $type='string'
+)
 </source>
 {| class="wikitable"
@@ Line 30: / Line 30: @@
 |-
 |}
-===Returns===
+* '''Returns'''
+* '''Defined''' on line 131 of libraries/joomla/filter/filterinput.php
-===Defined in===
-libraries/joomla/filter/filterinput.php
-===Referenced by===
 ===See also===
-<span class="editsection" style="font-size:76%;">
+* {{JVer|11.1}} '''JFilterInput::clean source code''' on [[jplatform:filter/filterinput.php#cl-123|BitBucket]]
-<nowiki>[</nowiki>[[SeeAlso:JFilterInput::clean|Edit See Also]]<nowiki>]</nowiki>
+* {{JVer|11.1}} Class [[API17:JFilterInput|JFilterInput]]
-</span>
+* {{JVer|11.1}} Subpackage [[API17:Subpackage_Filter|Filter]]
-* [[JFilterInput/11.1|JFilterInput]]
+* [[API17:JFilterInput::clean|Other versions of JFilterInput::clean]]
-* [[JFilterInput::clean|Other versions of this method]]
-{{SeeAlso:JFilterInput::clean}}
-===Examples===
+===User contributed notes===
-<CodeExamplesForm />
+=== Code Examples ===
 <dpl>
 noresultsheader=\n
 category=JFilterInput::clean
-category=CodeExample
+namespace=CodeExample
 category=MethodExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
-<noinclude>[[Category:JFilterInput]][[Category:JFilterInput::clean]]</noinclude>
+<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

API17