<!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>Returns the current row of a result set as an object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysqli-result.fetch-fields.html">mysqli_result::fetch_fields</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli-result.fetch-row.html">mysqli_result::fetch_row</a></div>
<div class="up"><a href="class.mysqli-result.html">mysqli_result</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysqli-result.fetch-object" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysqli_result::fetch_object</h1>
<h1 class="refname">mysqli_fetch_object</h1>
<p class="verinfo">(PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">mysqli_result::fetch_object</span> -- <span class="refname">mysqli_fetch_object</span> — <span class="dc-title">Returns the current row of a result set as an object</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysqli-result.fetch-object-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>mysqli_result::fetch_object</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code><span class="initializer"> = "stdClass"</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$params</code></span>
]] )</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>mysqli_fetch_object</strong></span>
( <span class="methodparam"><span class="type"><a href="class.mysqli-result.html" class="type mysqli_result">mysqli_result</a></span> <code class="parameter">$result</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code><span class="initializer"> = "stdClass"</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$params</code></span>
]] )</div>
<p class="para rdfs-comment">
The <span class="function"><strong>mysqli_fetch_object()</strong></span> will return the current row
result set as an object where the attributes of the object represent the
names of the fields found within the result set.
</p>
<p class="para">
Note that <span class="function"><strong>mysqli_fetch_object()</strong></span> sets the properties
of the object before calling the object constructor.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysqli-result.fetch-object-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">
result</code></dt>
<dd>
<p class="para">Procedural style only: A result set
identifier returned by <span class="function"><a href="mysqli.query.html" class="function">mysqli_query()</a></span>, <span class="function"><a href="mysqli.store-result.html" class="function">mysqli_store_result()</a></span>
or <span class="function"><a href="mysqli.use-result.html" class="function">mysqli_use_result()</a></span>.</p></dd>
<dt>
<code class="parameter">class_name</code></dt>
<dd>
<p class="para">
The name of the class to instantiate, set the properties of and return.
If not specified, a <strong class="classname">stdClass</strong> object is returned.
</p>
</dd>
<dt>
<code class="parameter">params</code></dt>
<dd>
<p class="para">
An optional <span class="type"><a href="language.types.array.html" class="type array">array</a></span> of parameters to pass to the constructor
for <code class="parameter">class_name</code> objects.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysqli-result.fetch-object-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an object with string properties that corresponds to the fetched
row or <strong><code>NULL</code></strong> if there are no more rows in resultset.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">Field names returned by this function
are <em class="emphasis">case-sensitive</em>.</span></p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function sets NULL fields to
the PHP <strong><code>NULL</code></strong> value.</span></p></blockquote>
</div>
<div class="refsect1 examples" id="refsect1-mysqli-result.fetch-object-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1954">
<p><strong>Example #1 Object oriented style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mysqli </span><span style="color: #007700">= new </span><span style="color: #0000BB">mysqli</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"world"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* check connection */<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">mysqli_connect_errno</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Connect failed: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">mysqli_connect_error</span><span style="color: #007700">());<br /> exit();<br />}<br /> <br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5"</span><span style="color: #007700">;<br /><br />if (</span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">)) {<br /><br /> </span><span style="color: #FF8000">/* fetch object array */<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$obj </span><span style="color: #007700">= </span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">fetch_object</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">printf </span><span style="color: #007700">(</span><span style="color: #DD0000">"%s (%s)\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$obj</span><span style="color: #007700">-></span><span style="color: #0000BB">Name</span><span style="color: #007700">, </span><span style="color: #0000BB">$obj</span><span style="color: #007700">-></span><span style="color: #0000BB">CountryCode</span><span style="color: #007700">);<br /> }<br /><br /> </span><span style="color: #FF8000">/* free result set */<br /> </span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />}<br /><br /></span><span style="color: #FF8000">/* close connection */<br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-1955">
<p><strong>Example #2 Procedural style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"world"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* check connection */<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">mysqli_connect_errno</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Connect failed: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">mysqli_connect_error</span><span style="color: #007700">());<br /> exit();<br />}<br /><br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #DD0000">"SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5"</span><span style="color: #007700">;<br /><br />if (</span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #0000BB">$query</span><span style="color: #007700">)) {<br /><br /> </span><span style="color: #FF8000">/* fetch associative array */<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$obj </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">printf </span><span style="color: #007700">(</span><span style="color: #DD0000">"%s (%s)\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$obj</span><span style="color: #007700">-></span><span style="color: #0000BB">Name</span><span style="color: #007700">, </span><span style="color: #0000BB">$obj</span><span style="color: #007700">-></span><span style="color: #0000BB">CountryCode</span><span style="color: #007700">);<br /> }<br /><br /> </span><span style="color: #FF8000">/* free result set */<br /> </span><span style="color: #0000BB">mysqli_free_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* close connection */<br /></span><span style="color: #0000BB">mysqli_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above examples will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Pueblo (USA)
Arvada (USA)
Cape Coral (USA)
Green Bay (USA)
Santa Clara (USA)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mysqli-result.fetch-object-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="mysqli-result.fetch-array.html" class="function" rel="rdfs-seeAlso">mysqli_fetch_array()</a> - Fetch a result row as an associative, a numeric array, or both</span></li>
<li class="member"><span class="function"><a href="mysqli-result.fetch-assoc.html" class="function" rel="rdfs-seeAlso">mysqli_fetch_assoc()</a> - Fetch a result row as an associative array</span></li>
<li class="member"><span class="function"><a href="mysqli-result.fetch-row.html" class="function" rel="rdfs-seeAlso">mysqli_fetch_row()</a> - Get a result row as an enumerated array</span></li>
<li class="member"><span class="function"><a href="mysqli.query.html" class="function" rel="rdfs-seeAlso">mysqli_query()</a> - Performs a query on the database</span></li>
<li class="member"><span class="function"><a href="mysqli-result.data-seek.html" class="function" rel="rdfs-seeAlso">mysqli_data_seek()</a> - Adjusts the result pointer to an arbitrary row in the result</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysqli-result.fetch-fields.html">mysqli_result::fetch_fields</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli-result.fetch-row.html">mysqli_result::fetch_row</a></div>
<div class="up"><a href="class.mysqli-result.html">mysqli_result</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
