<!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>Parse a string following a given rule set</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bbcode-destroy.html">bbcode_destroy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bbcode-set-arg-parser.html">bbcode_set_arg_parser</a></div>
<div class="up"><a href="ref.bbcode.html">BBCode Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.bbcode-parse" class="refentry">
<div class="refnamediv">
<h1 class="refname">bbcode_parse</h1>
<p class="verinfo">(PECL bbcode >= 0.9.0)</p><p class="refpurpose"><span class="refname">bbcode_parse</span> — <span class="dc-title">Parse a string following a given rule set</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bbcode-parse-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>bbcode_parse</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bbcode_container</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$to_parse</code></span>
)</div>
<p class="para rdfs-comment">
This function parse the string to_parse following the rules in the
bbcode_container created by <span class="function"><a href="function.bbcode-create.html" class="function">bbcode_create()</a></span>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bbcode-parse-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">bbcode_container</code></dt>
<dd>
<p class="para">
BBCode_Container resource returned by <span class="function"><a href="function.bbcode-create.html" class="function">bbcode_create()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">to_parse</code></dt>
<dd>
<p class="para">
The string we need to parse.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bbcode-parse-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the parsed string, or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bbcode-destroy.html">bbcode_destroy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bbcode-set-arg-parser.html">bbcode_set_arg_parser</a></div>
<div class="up"><a href="ref.bbcode.html">BBCode Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
