API15

JMailHelper/cleanText: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 43: Line 43:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=cleanText
  category=cleanText
  category=JMailHelper
  category=JMailHelper
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 00:57, 25 March 2017

Description

Cleans multi-line inputs.

[<! removed edit link to red link >]

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

Syntax

cleanText($value)
Parameter Name Default Value Description
$value $value Multi-line string to be cleaned.

Returns

string Cleaned multi-line string.

Defined in

libraries/joomla/mail/helper.php

Importing

jimport( 'joomla.mail.helper' );

Source Body

function cleanText( $value ) {
        return trim( preg_replace( '/(%0A|%0D|\n+|\r+)(content-type:|to:|cc:|bcc:)/i', '', $value ) );
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

Code Examples