Source of: /manual/en/datetime.format.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.datetime.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'datetime.format.php',
1 => 'DateTime::format',
),
'up' =>
array (
0 => 'class.datetime.php',
1 => 'The DateTime class',
),
'prev' =>
array (
0 => 'datetime.diff.php',
1 => 'DateTime::diff',
),
'next' =>
array (
0 => 'datetime.getlasterrors.php',
1 => 'DateTime::getLastErrors',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="datetime.format" class="refentry">
<div class="refnamediv">
<h1 class="refname">DateTime::format</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">DateTime::format</span> — <span class="dc-title">Returns date formatted according to given format</span></p>
</div>
<a name="datetime.format.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><b>DateTime::format</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$format</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="function.date-format.php" class="function">date_format</a></span>
( <span class="methodparam"><span class="type"><a href="class.datetime.php" class="type DateTime">DateTime</a></span> <tt class="parameter">$object</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$format</tt></span>
)</div>
</div>
<a name="datetime.format.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">object</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">Procedural style only: A <a href="class.datetime.php" class="classname">DateTime</a> object
returned by <a href="function.date-create.php" class="function">date_create()</a></p></dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">format</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Format accepted by <a href="function.date.php" class="function">date()</a>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="datetime.format.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns formatted date on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="datetime.format.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Displaying the date and time using the procedural form</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />date_default_timezone_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'Europe/London'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$datetime </span><span style="color: #007700">= </span><span style="color: #0000BB">date_create</span><span style="color: #007700">(</span><span style="color: #DD0000">'2008-08-03 14:52:10'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">date_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$datetime</span><span style="color: #007700">, </span><span style="color: #DD0000">'jS, F Y'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">date_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$datetime</span><span style="color: #007700">, </span><span style="color: #0000BB">DATE_ATOM</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
<p class="para">
</p><div class="example">
<p><b>Example #2 Displaying the date and time using the object oriented form</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />date_default_timezone_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'Europe/London'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$datetime </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">'2008-08-03 14:52:10'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$datetime</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #DD0000">'jS, F Y'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$datetime</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">DATE_ATOM</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?><br /></span>?></span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
3rd, August 2008
2008-08-03T14:52:10+01:00
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="datetime.format.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.date.php" class="function" rel="rdfs-seeAlso">date()</a> - Format a local time/date</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
