CronInterface.php

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

Namespace

Drupal\Core

File

core/lib/Drupal/Core/CronInterface.php

View source 
<?php

namespace Drupal\Core;


/**
 * An interface for running cron tasks.
 *
 * @see https://www.drupal.org/docs/administering-a-drupal-site/cron-automated-tasks
 */
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();

}

Interfaces

Title Deprecated Summary
CronInterface An interface for running cron tasks.

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