UberFoX: Created page with "

 StrTr( , ,  ) StrTr( ,  )

=== Description === If given three arguments, this function returns a copy of str where all occurrence..."

2015-09-19T18:46:19Z

Created page with "<pre> StrTr( <str>, <from>, <to> ) StrTr( <str>, <replace_pairs> ) </pre> === Description === If given three arguments, this function returns a copy of str where all occurrence..."

New page

<pre>
StrTr( <str>, <from>, <to> )
StrTr( <str>, <replace_pairs> )
</pre>

=== Description ===

If given three arguments, this function returns a copy of str where all occurrences of each character in from have been translated to the corresponding character in to, i.e., every occurrence of $from[$n] has been replaced with $to[$n], where $n is a valid offset in both arguments.

If from and to have different lengths, the extra characters in the longer of the two are ignored. The length of str will be the same as the return value's.

If given two arguments, the second should be an array in the form array('from' => 'to', ...). The return value is a string where all the occurrences of the array keys have been replaced by the corresponding values. The longest keys will be tried first. Once a substring has been replaced, its new value will not be searched again.

In this case, the keys and the values may have any length, provided that there is no empty key; additionally, the length of the return value may differ from that of str. However, this function will be the most efficient when all the keys have the same size.

=== Parameters ===

==== str ====

The string being translated.

==== from ====

The string being translated to to.

==== to ====

The string replacing from.

==== replace_pairs ====

The replace_pairs parameter may be used instead of to and from, in which case it's an array in the form array('from' => 'to', ...).

=== Return Value ===

Success: Returns the translated string.

Failure: Returns NULL

=== Remarks ===

None.

=== Example ===

Basic Example

<syntaxhighlight lang="sputnik">
say strtr("Hilla Warld","ia","eo");
// PRINTS
// Hello World
</syntaxhighlight>

Replace Pairs Example

<syntaxhighlight lang="sputnik">
$trans = array("h" => "-", "hello" => "hi", "hi" => "hello");
say strtr("hi all, I said hello", $trans);
// PRINTS
// hello all, I said hi
</syntaxhighlight>

[[Category:Core Function]]

Core Function StrTr - Revision history

UberFoX: Created page with "
StrTr( , , ) StrTr( , )
=== Description === If given three arguments, this function returns a copy of str where all occurrence..."