Unofficial SMF API Documentation

./Sources/ManageScheduledTasks.php

ManageScheduledTasks

function ManageScheduledTasks(): void

Scheduled tasks management dispatcher. This function checks permissions and delegates to the appropriate function based on the sub-action.

Everything here requires admin_forum permission.

Uses ManageScheduledTasks template file Uses ManageScheduledTasks language file

Integration hooks
integrate_manage_scheduled_tasks

ScheduledTasks

function ScheduledTasks(): void

List all the scheduled task in place on the forum.

list_getScheduledTasks

function list_getScheduledTasks(int $start, int $items_per_page, string $sort): array

Callback function for createList() in ScheduledTasks().

Type Parameter Description
int $start The item to start with (not used here)
int $items_per_page The number of items to display per page (not used here)
string $sort A string indicating how to sort things (not used here)

EditTask

function EditTask(): void

Function for editing a task.

TaskLog

function TaskLog(): void

Show the log of all tasks that have taken place.

Uses ManageScheduledTasks language file

list_getTaskLogEntries

function list_getTaskLogEntries(int $start, int $items_per_page, string $sort): array

Callback function for createList() in TaskLog().

Type Parameter Description
int $start The item to start with (for pagination purposes)
int $items_per_page How many items to display per page
string $sort A string indicating how to sort the results

list_getNumTaskLogEntries

function list_getNumTaskLogEntries(): int

Callback function for createList() in TaskLog().

TaskSettings

function TaskSettings(bool $return_config = false): void|array

This handles settings related to scheduled tasks

Type Parameter Description
bool $return_config Whether or not to return the config vars. Used in the admin search.
Integration hooks
integrate_scheduled_tasks_settings
integrate_save_scheduled_tasks_settings

Suggest an edit to this page on GitHub