carlcs/craft-autoexpire

There is no license information available for the latest version (v1.2.0) of this package.

Auto Expire plugin for Craft CMS

Installs: 378

Dependents: 0

Suggesters: 0

Security: 0

Stars: 17

Watchers: 3

Forks: 0

Open Issues: 1

Type:craft-plugin

v1.2.0 2016-06-23 09:55 UTC

This package is auto-updated.

Last update: 2024-11-20 04:37:24 UTC


README

This plugin allows to set an entry’s Expiry Date, Post Date or any custom date field automatically on entry save. The date value is generated from a Twig template which can be set up in the plugin settings.

Installation

The plugin is available on Packagist and can be installed using Composer. You can also download the latest release and copy the files into craft/plugins/autoexpire/.

$ composer require carlcs/craft-autoexpire

Usage

Navigate to the plugin’s settings page and add a new rule to define the conditions for how dates are being set by the plugin.

  • Select the section and entry type of the entries you want the rule to be applied to.
  • Select the date field you want to apply this rule to.
  • Enter the Twig code which is rendered and set to the date field on entry save. You can include tags that output entry properties.

Configuration

Expiration Date

Auto Expire uses the same approach to parse a Twig Template from a field as Craft’s Title Format settings field, please see Dynamic Entry Titles in the Craft Documentation for more information about the expected syntax.

When using tags to output date properties keep in mind that, by default, Twig returns dates in "Y-m-d" format without any time information (which is the same as if you had set it to 12:00 AM).

That’s why you probably want to use Twig’s date filter to explicitly define a format containing the time, i.e. date('c').

Examples:

  • Set to a fixed date:

    2015-05-13 13:00
  • Set a date based on the entry’s Post Date:

    {{ object.postDate|date_modify('+7 days')|date('c') }}

    or using another relative time format:

    {{ object.postDate|date_modify('first day of next month 5am')|date('c') }}
  • More complex example using a conditional (ternary syntax):

    {{ object.myDateTimeField ? object.myDateTimeField|date('c') : object.postDate|date_modify('+7 days')|date('c') }}

Allow User Changes

Check this field to allow users to overwrite the automatically set date. In this case the plugin will only set the date if the date field is left blank by the user.