This module adds a field type that allows you to schedule actions for entities. By default, it can schedule the publishing or unpublishing of an entity. You can also create custom plugins to schedule other actions, such as changing moderation states or sending emails, all of which are executed by cron.
The scheduler field module add a scheduler field type. Scheduler field type allow to configure some schedules actions to fieldable entities.
The different schedules actions are defined as plugin. By default, two plugins are available, but you can add your own :
- scheduler_field_type_disabled : This plugin does not provide schedule features, used by default to not have scheduled actions.
- scheduler_field_type_publication : This plugin change status of entities to publish/unpublish entity changing 'status' property.
Thanks to this plugins, you could add your own plugin to :
- Change a moderation/workflow state
- Change field values
- Send e-mails
- Do whathever you want
Cron is used and has to be called to execute scheduled actions.
The scheduled field module store every informations on field table, not entities.
How to use ?
- Enable the module
- Go to your entity field settings page and add a new Schedule field type
- Configure the field type (name, default values etc)
- Create/edit the entity, your new schedule field type is available, and you can define your schedule type action (disabled or publication by default), start date and end date (optional)
- Save entity
- Next time the cron will run, if action has to be executed depending of your field settings (type and dates), scheduled action will be made.
Compatibility
This publish plugin provided by this module is not compatible with content_moderation. It does not allow to schedule actions after revisions transitions or based on revisions changes. Otherwise, as module is based on plugins, you still can build your own plugin to implement schedule actions based on your workflow. Take a look at https://www.drupal.org/project/scheduler_field/issues/3313975 for further informations.
Alternative
All of the alternatives modules are based on custom entities, some of them applies only on nodes, or are not expandable.
The aim of Scheduler field module is to not use custom entity, but to store schedule data in field table, as closed as the entity as possible. Thanks to that, getting scheduled information is much more easier for import, export, migrate, views, querying etc.
The second goal is to be fully expandable. We cannot provide all the functionnalities YOU need to schedule, but thanks to plugins, you can easily make your own.