interface CronInterface

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/CronInterface.php \Drupal\Core\CronInterface
  2. 8.9.x core/lib/Drupal/Core/CronInterface.php \Drupal\Core\CronInterface
  3. 10 core/lib/Drupal/Core/CronInterface.php \Drupal\Core\CronInterface

An interface for running cron tasks.

Hierarchy

Expanded class hierarchy of CronInterface

All classes that implement CronInterface

See also

https://www.drupal.org/docs/administering-a-drupal-site/cron-automated-…

3 files declare their use of CronInterface
AutomatedCron.php in core/modules/automated_cron/src/EventSubscriber/AutomatedCron.php
CronController.php in core/modules/system/src/CronController.php
CronForm.php in core/modules/system/src/Form/CronForm.php

File

core/lib/Drupal/Core/CronInterface.php, line 10

Namespace

Drupal\Core
View source 
interface CronInterface {
    
    /**
     * Executes a cron run.
     *
     * Do not call this function from a test. Use $this->cronRun() instead.
     *
     * @return bool
     *   TRUE upon success, FALSE otherwise.
     */
    public function run();

}

Members

Title Modifiers Object type Summary Overrides
CronInterface::run public function Executes a cron run. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.