<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Perform the rot13 transform on a string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.str-replace.html">str_replace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.str-shuffle.html">str_shuffle</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.str-rot13" class="refentry">
<div class="refnamediv">
<h1 class="refname">str_rot13</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">str_rot13</span> — <span class="dc-title">Perform the rot13 transform on a string</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.str-rot13-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>str_rot13</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
)</div>
<p class="para rdfs-comment">
Performs the ROT13 encoding on the <em><code class="parameter">str</code></em> argument and
returns the resulting string.
</p>
<p class="para">
The ROT13 encoding simply shifts every letter by 13 places in the alphabet
while leaving non-alpha characters untouched. Encoding and decoding are
done by the same function, passing an encoded string as argument will
return the original version.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.str-rot13-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">str</code></em></span>
<dd>
<p class="para">
The input string.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.str-rot13-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the ROT13 version of the given string.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.str-rot13-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4880">
<p><strong>Example #1 <span class="function"><strong>str_rot13()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">str_rot13</span><span style="color: #007700">(</span><span style="color: #DD0000">'PHP 4.3.0'</span><span style="color: #007700">); </span><span style="color: #FF8000">// CUC 4.3.0<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.str-rot13-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.3.0</td>
<td>
The behaviour of this function was fixed. Before this fix, the
<em><code class="parameter">str</code></em> was also modified, as if it was passed
by reference.
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.str-replace.html">str_replace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.str-shuffle.html">str_shuffle</a></div>
<div class="up"><a href="ref.strings.html">String Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
