View source for Manual:WfTimestamp

<languages/>
{{DISPLAYTITLE:Manual:wfTimestamp{{#translation:}}}}
<translate>
==Overview== <!--T:14-->
</translate>
<translate><!--T:40--> <tvar name=1><code>wfTimestamp()</code></tvar> (part of <tvar name=2>[[Special:MyLanguage/Manual:GlobalFunctions.php|GlobalFunctions.php]]</tvar>) provides functionality to convert between common timestamp formats, including [[<tvar name=3>Special:MyLanguage/Manual:Timestamp</tvar>|MediaWiki timestamps]],  [[w:Unix_time|UNIX timestamps]], MySQL <tvar name=4><code>[http://dev.mysql.com/doc/refman/5.1/en/datetime.html DATETIME]</code></tvar> format, [<tvar name=5>http://www.faqs.org/rfcs/rfc2822.html</tvar> RFC 2822 format] and more.</translate>
<translate><!--T:15--> See [[<tvar name=1>#Formats</tvar>|formats]] below for a full list.</translate>

<translate>
<!--T:1-->
Timestamps will be output without a timezone or in the GMT timezone, as specified by the particular format.
</translate>

<translate><!--T:16--> Never use <tvar name=1>wfTimestamp()</tvar> when inserting a timestamp into the database.</translate>
<translate><!--T:17--> This will break in Postgres and possibly other non-MySQL databases.</translate>
<translate><!--T:18--> Instead use <tvar name=1>[[Special:MyLanguage/Manual:Database.php#Timestamp_functions|$dbw->timestamp()]]</tvar></translate>

<translate>
==Usage== <!--T:2-->
</translate>
<syntaxhighlight lang="php">
wfTimestamp( $output_format, $timestamp )
</syntaxhighlight>

* <translate><!--T:3--> Returns a timestamp of type string in the format specified by the <tvar name=1><code>$output_format</code></tvar> argument.</translate>
* <translate><!--T:19--> Throws <tvar name=1><code>MWException</code></tvar> if an incorrect [[<tvar name=2>#Formats</tvar>|formats]] is passed via the <tvar name=3><code>$output_format</code></tvar> argument.</translate>
* <translate><!--T:4--> Returns <tvar name=1><code>false</code></tvar> if an invalid or unrecognized timestamp is passed via the <tvar name=2><code>$timestamp</code></tvar> argument.</translate>

{| class="wikitable" |
|+
! <translate><!--T:20--> Argument</translate>
! <translate><!--T:21--> Default</translate>
! <translate><!--T:5--> Notes</translate>
|-
| <code>$output_format</code>
| <code>TS_UNIX</code>
| <translate><!--T:6--> Must be one of the constants listed in the <tvar name=1>[[#Formats|formats]]</tvar> table.</translate>
|-
| <code>$timestamp</code>
| <translate><!--T:7--> The current time</translate>
| <translate><!--T:8--> Should be a literal timestamp (e.g. <tvar name=1><code>2010-12-03 22:07:25</code></tvar>).</translate> <translate><!--T:9--> Any format listed in the [[<tvar name=1>#Formats</tvar>|formats]] table can be used.</translate>
|}

; <translate><!--T:10--> Call with no arguments to return the current time in UNIX time format.</translate>

<code class="mw-code mw-highlight" style="display:block"><!--
-->{{#tag:span|echo|class=k}} wfTimestamp(); {{#tag:span|// {{#time:U||en}} |class=c1}}
</code>

; <translate><!--T:11--> Call with one argument to return the current time in the specified format.</translate>

<code class="mw-code mw-highlight" style="display:block"><!--
-->{{#tag:span|echo|class=k}} wfTimestamp( TS_ISO_8601 ); {{#tag:span|// {{#time:Y-m-d\TH:i:s\Z||en}} |class=c1}}
</code>

; <translate><!--T:12--> Call with two arguments to return an arbitrary timestamp in the specified format.</translate>

<translate><!--T:13--> Note that the timestamp can be in any format that <tvar name=1><code>wfTimestamp()</code></tvar> can output.</translate>

<code class="mw-code mw-highlight" style="display:block"><!--
-->{{#tag:span|$timestamp|class=nv}} = {{#tag:span|{{#time:YmsHis||en}}|class=mi}};
{{#tag:span|echo|class=k}} wfTimestamp( TS_ISO_8601, {{#tag:span|$timestamp|class=nv}} ); {{#tag:span|// {{#time:Y-m-d\TH:i:s\Z||en}} |class=c1}}
&#32;
{{#tag:span|$timestamp|class=nv}} = {{#tag:span|'{{#time:Y-m-d\TH:i:s\Z||en}}'|class=s1}};
{{#tag:span|echo|class=k}} wfTimestamp( TS_RFC2822, {{#tag:span|$timestamp|class=nv}} ); {{#tag:span|// {{#time:D, d M Y H:i:s" GMT"||en}} |class=c1}}
</code>

<translate>
==Formats== <!--T:41-->
</translate>
{| class="wikitable" |
|+
! <translate><!--T:22--> Type</translate>
! <translate><!--T:23--> Constant</translate>
! <translate><!--T:24--> Format</translate><ref><translate><!--T:25--> Formatting codes per PHP's <tvar name=1><code>[http://php.net/date date()]</code></tvar> function.</translate></ref>
! <translate><!--T:26--> Example</translate>
! <translate><!--T:27--> Notes</translate>
|-
| MySQL <code>DATETIME</code>|| <code>TS_DB</code> || <code>Y-m-d H:i:s</code> ||{{#time:Y-m-d H:i:s||en}}
| 
|-
| DB2 || <code>TS_DB2</code> || <code>Y-m-d H:i:s</code> || {{#time:Y-m-d H:i:s||en}}
| <translate><!--T:43--> Removed in <tvar name=1>[[gerrit:50764]]</tvar></translate> {{MW version|version=1.15|version2=1.20}}
|-
| Exif || <code>TS_EXIF</code> || <code>Y:m:d H:i:s</code> || {{#time:Y:m:d H:i:s||en}}
| <translate><!--T:28--> Shouldn't ever be used, but is included for completeness.</translate> <ref><translate><!--T:29--> Documented on page 28 (for the <tvar name=1>DateTime</tvar> tag) and page 36 (for the <tvar name=2>DateTimeOriginal</tvar> and <tvar name=3>DateTimeDigitized</tvar> tags) of the Exif 2.2 specification.</translate> <translate><!--T:30--> Download the specification at <tvar name=1>http://exif.org/Exif2-2.PDF</tvar></translate></ref>
|-
| ISO 8601 <translate><!--T:31--> (no timezone)</translate> || <code>TS_ISO_8601</code> || <code>Y-m-d\TH:i:s\Z</code> || {{#time:Y-m-d\TH:i:s\Z||en}}
| <translate><!--T:32--> Used by <tvar name=1>[[Special:Export]]</tvar> and the [[<tvar name=2>Special:MyLanguage/API:Main page</tvar>|API]]</translate>
|-
| ISO 8601 <translate><!--T:33--> basic (no timezone)</translate> || <code>TS_ISO_8601_BASIC</code> || <code>Ymd\THis\Z</code> || {{#time:Ymd\THis\Z||en}}
| <translate><!--T:34--> Used by <tvar name=1>[[ResourceLoader]]</tvar></translate>
|-
| MediaWiki || <code>TS_MW</code> || <code>YmdHis</code> || {{#time:YmdHis||en}}
| 
|-
| Oracle || <code>TS_ORACLE</code> || <code>d-m-Y H:i:s.000000</code> || {{#time:d-m-Y H:i:s.000000||en}}
| <translate><!--T:35--> Was <tvar name=1>'d-M-y h.i.s A' . ' +00:00'</tvar> before <tvar name=2>[[phab:rSVN51500]]</tvar></translate>
|-
| PostgreSQL || <code>TS_POSTGRES</code> || <code>Y-m-d H:i:s+00</code> || {{#time:Y-m-d H:i:s+00||en}}
| <translate><!--T:42--> Was <tvar name=1>'Y-m-d H:i:s' . ' GMT'</tvar> before <tvar name=2>[[gerrit:459601]]</tvar></translate>
|-
| {{IETF RFC|2822}} || <code>TS_RFC2822</code> || <code>D, d M Y H:i:s</code> || {{#time:D, d M Y H:i:s" GMT"||en}}
| <translate><!--T:36--> For email and HTTP headers</translate>
|-
| UNIX time || <code>TS_UNIX</code> || <code>U</code> || {{#time:U||en}}
| <translate><!--T:37--> Number of seconds since <tvar name=1>1970-01-01 00:00:00</tvar> UTC</translate>
|}
<references/>

<translate>
==See also== <!--T:38-->

<!--T:39-->
* [<tvar name=1>https://doc.wikimedia.org/mediawiki-core/master/php/GlobalFunctions_8php.html#ae67c8f2c23d3bb2ea7173a1823355d47</tvar> source docs for wfTimestamp()]
</translate>