# Scheduler

[![Build Status](https://git.drupalcode.org/project/scheduler/badges/2.x/pipeline.svg)](https://git.drupalcode.org/project/scheduler/-/pipeline_schedules)

Scheduler gives website editors the ability to schedule content to be published
and unpublished at specified dates and times in the future.

Scheduler provides hooks and events for third-party modules to interact with the
process during content editing and during cron publishing and unpublishing.

A plugin system allows support for any Drupal entity type that has the concept
of a 'published' status. As at Scheduler version 2.0 Node content, Media
entities, Commerce Products and Taxonomy Terms are supported.

## Requirements

 * Scheduler uses the following core components:
     Actions, Datetime, Field, Node, Text, Filter, User, System, Views.

 * There are no special requirements outside core.

## Integration with other modules

 * [Rules](https://www.drupal.org/project/rules):
     Scheduler provides actions, conditions and events which can be used in
     Rules to build additional functionality.

 * [Token](https://www.drupal.org/project/token):
     Scheduler provides tokens for the two scheduling dates.

 * [Devel](https://www.drupal.org/project/devel):
     When generating new test content via Devel Generate, Scheduler can add
     publishing dates automatically.

 * [Scheduler Content Moderation Integration](https://www.drupal.org/project/scheduler_content_moderation_integration)
     If you use core Content Moderation then you should also install this
     sub-module, contributed by the folks at [Thunder](https://www.drupal.org/thunder)

 * [Media](https://www.drupal.org/docs/8/core/modules/media):
     Core media items can be scheduled for publishing and unpublishing.

 * [Commerce](https://www.drupal.org/project/commerce):
     Commerce products can be scheduled for publishing and unpublishing.

 * [Taxonomy](https://www.drupal.org/docs/8/core/modules/taxonomy):
     Core taxonomy terms can be scheduled for publishing and unpublishing.

## Installation

 * Install as you would normally install a contributed Drupal module. See the
   Drupal [module installation guide](https://drupal.org/documentation/install/modules-themes/modules-8)
   for further information.

 * The [Scheduler project page](https://drupal.org/project/scheduler) has
   information regarding versions and Core compatibility.

## Configuration

 * Configure user permissions via url /admin/people/permissions#module-scheduler
   or Administration » People » Permissions

   - "Schedule publishing and unpublishing of {type}"

     Users with this permission can enter dates and times for publishing and/or
     unpublishing, when editing content of types which are Scheduler-enabled.

   - "View scheduled {type}"

     Users can always see their own scheduled content, via a tab on their user
     page. This permissions grants additional authority to see the full list of
     scheduled content by any author, providing the user also has the core
     permission 'access content overview' or the equivalent for other entity
     types.

   - "Administer scheduler"

     This permission allows the user to alter all Scheduler settings. It should
     therefore only be given to trusted admin roles.

 * Configure the Scheduler global options via /admin/config/content/scheduler
   or Administration » Configuration » Content Authoring » Scheduler

   - Basic settings: allow a date only and set a default time.

   - Lightweight Cron: This gives sites admins the granularity to run
     Scheduler's functions only on more frequent crontab jobs than the full
     Drupal cron run.

  * Configure the Scheduler settings per entity type:
    - Administration » Structure » Content Types » Edit
    - Administration » Structure » Media Types » Edit
    - Administration » Commerce » Configuration » Product Types » Edit
    - Administration » Structure » Taxonomy » Vocabulary » Edit
    - For supported entity types without bundles:
      Administration » Configuration » Content Authoring » Scheduler
      (use the entity link in the drop-button)

 * The system status report at /admin/reports/status has a `Scheduler Timecheck`
   section, giving details of the server time, default site time and current
   user time.

## Troubleshooting

 * Submit bug reports and feature requests to the [project issue tracker](https://drupal.org/project/issues/scheduler)

 * For help with crontab jobs read the Drupal [cron documentation](https://drupal.org/cron)

## Maintainers

<!---  cSpell:disable --->
<!---  Do not want to add these names into the cspell-project-words file --->

Current maintainers:

- [Pieter Frenssen](https://www.drupal.org/u/pfrenssen) 2014(6.x)-current
- [Jonathan Smith](https://www.drupal.org/u/jonathan1055) 2013(6.x)-current

Previous maintainers:

- [Rick Manelius](https://www.drupal.org/u/rickmanelius) 2013(6.x)-2014(7.x)
- [Eric Schaefer](https://www.drupal.org/u/eric-schaefer) 2008(5.x)-2013(7.x)
- [Sami Kimini](https://www.drupal.org/u/skiminki) 2008(5.x)
- [Ted Serbinski](https://www.drupal.org/u/m3avrck) 2007(4.7)
- [Andy Kirkham](https://www.drupal.org/u/ajk) 2006(4.7)-2008(6.x)
- [David Norman](https://www.drupal.org/u/deekayen) 2006(4.x)
- [Tom Dobes](https://www.drupal.org/user/4179) 2004(4.x)
- [Gábor Hojtsy](https://www.drupal.org/u/gábor-hojtsy) 2003(4.3)-2005(5.x)
- [Moshe Weitzman](https://www.drupal.org/u/moshe-weitzman) 2003(4.2)-2006(4.6)