====== ComboStrap - Date Component ======


<note warning>
The date component was deprecated for the [[howto:date|date variable]].

This article has been saved for historical purpose.

Why ?
  * The function [[https://www.php.net/manual/en/function.strftime.php|strftime]] was deprecated and will be no more available from php version 8
  * The date format is not the standard.
  * The [[:docs:templating:pipeline#format|pipeline format function]] can be enhanced to format also number.
</note>
===== About =====



With the date component, you could format any date:
  * the today's date
  * any [[docs:metadata:date_format|string date]]
  * or any [[docs:templating:variable|page date attribute]] such as:
      * ''date_created'' or ''date_modified''  of a page
      * ''date_published'' (if specified, see [[docs:page:published]])
      * ''date_start'' or ''date_end'' of an [[docs:type:event|event]]




===== Example =====

==== Today's date ====

<webcode name="Default" frameborder="0">
  * The markup
<code dw>
<date/>
</code>
  * The output is a date formatted to the default format.
</webcode>
<note>
To have it refresh every day, we expire the [[docs:cache:cache|cache date daily]]
<code dw>
<cache expiration="@daily"/>
</code>
</note>
<cache expiration="@daily"/>

==== Today's date - short format ====

<webcode name="Default" frameborder="0">
  * Today's date with a short month description and the day number US style
<code dw>
<date format="%h %d"/>
</code>
  * The output:
</webcode>


==== Today's date in French ====


<webcode name="Default" frameborder="0">
  * The markup with the [[docs:locale:locale|locale]] attribute with just the region (ie country) as value.
<code dw>
<date locale="fr"/>
</code>
  * The output is a date formatted with French word.
</webcode>

==== Date specified manually ====


<webcode name="Default" frameborder="0">
  * When you specify a date, you need to write it in a [[docs:metadata:date_format|accepted date format]]
<code dw>
<date format="%A">2021-09-27</date>
</code>
  * The output gives the day name of the date (ie ''%A'')
</webcode>

==== Date of a page ====

You can even print a date metadata of a page.
<webcode name="Default" frameborder="0">
  * For instance, for the [[docs:page:published|published date]] of this article
<code dw>
<date>$date_published</date>
</code>
  * The output will be:
</webcode>

===== Syntax =====

  * For the today's date
<code dw>
<date format="formatValue" lang="language"/>
</code>
  * When specifying a date value
<code dw>
<date format="formatValue" lang="language">dateValue</date>
</code>
where:
  * ''format'' is any [[https://www.php.net/manual/en/function.strftime.php|format accepted by the strftime function]]
  * ''language'' is a [[:docs:locale:lang|language]] value. <inote>You can also just use the [[:docs:locale:region|country value]] (for instance, the value ''us'' is valid).</inote>
  * ''dateValue'' is:
      * one of the [[docs:metadata:date_format|accepted date format]]
      * or any [[docs:templating:variable|page date metadata]].