{"templateId":"markdown","versions":[{"version":"9.0","label":"9.0","link":"/classes/whmcs/scheduling/task/abstracttask","default":true,"active":true,"folderId":"9d7dc099"},{"version":"8.13","label":"8.13","link":"/classes/8.13/whmcs/scheduling/task/abstracttask","default":false,"active":false,"folderId":"9d7dc099"}],"sharedDataIds":{"sidebar":"sidebar-classes/@8.13/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"WHMCS\\Scheduling\\Task\\AbstractTask","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"whmcsschedulingtaskabstracttask","__idx":0},"children":["WHMCS\\Scheduling\\Task\\AbstractTask"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Class"]}," · extends ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Model"]}," · implements ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DecoratorItemInterface"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TaskInterface"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AbstractTask"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"traits","__idx":1},"children":["Traits"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DecoratorItemTrait"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RegisterTrait"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"methods","__idx":2},"children":["Methods"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"createtable","__idx":3},"children":["createTable"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function createTable($drop = false)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"firstofclassornew","__idx":4},"children":["firstOfClassOrNew"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public static function firstOfClassOrNew(array $attributes = [])\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"register","__idx":5},"children":["register"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public static function register($allowDuplicates = false)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"unregister","__idx":6},"children":["unregister"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public static function unregister(): void\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unregisters the task by removing it from the database."," ","If the task has a status, it will also be deleted."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getdefaultattributes","__idx":7},"children":["getDefaultAttributes"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getDefaultAttributes()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"newcollection","__idx":8},"children":["newCollection"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function newCollection(array $models = array())\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["array"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$models"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Collection"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getname","__idx":9},"children":["getName"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getName()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setname","__idx":10},"children":["setName"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function setName($name)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"run","__idx":11},"children":["run"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function run()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getpriority","__idx":12},"children":["getPriority"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getPriority()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setpriority","__idx":13},"children":["setPriority"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function setPriority($priority)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getdescription","__idx":14},"children":["getDescription"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getDescription()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setdescription","__idx":15},"children":["setDescription"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function setDescription($description)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getfrequencyminutes","__idx":16},"children":["getFrequencyMinutes"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getFrequencyMinutes()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setfrequencyminutes","__idx":17},"children":["setFrequencyMinutes"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function setFrequencyMinutes($minutes)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"anticipatednextrun","__idx":18},"children":["anticipatedNextRun"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function anticipatedNextRun(Carbon $date = null)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"isenabled","__idx":19},"children":["isEnabled"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function isEnabled()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setenabled","__idx":20},"children":["setEnabled"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function setEnabled($state)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"isperiodic","__idx":21},"children":["isPeriodic"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function isPeriodic()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setperiodic","__idx":22},"children":["setPeriodic"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function setPeriodic($state)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getstatus","__idx":23},"children":["getStatus"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getStatus()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getstatusattribute","__idx":24},"children":["getStatusAttribute"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getStatusAttribute($status)\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"status","__idx":25},"children":["status"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function status()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getsystemname","__idx":26},"children":["getSystemName"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getSystemName()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getaccesslevel","__idx":27},"children":["getAccessLevel"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getAccessLevel()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getoutputkeys","__idx":28},"children":["getOutputKeys"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getOutputKeys()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Returns"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["array"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"isdailytask","__idx":29},"children":["isDailyTask"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function isDailyTask()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"monthlydayofexecution","__idx":30},"children":["monthlyDayOfExecution"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function monthlyDayOfExecution()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"isskipdailycron","__idx":31},"children":["isSkipDailyCron"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function isSkipDailyCron()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getdetailurl","__idx":32},"children":["getDetailUrl"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getDetailUrl()\n","lang":"php"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getfailureurl","__idx":33},"children":["getFailureUrl"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"public function getFailureUrl()\n","lang":"php"},"children":[]}]},"headings":[{"value":"WHMCS\\Scheduling\\Task\\AbstractTask","id":"whmcsschedulingtaskabstracttask","depth":1},{"value":"Traits","id":"traits","depth":2},{"value":"Methods","id":"methods","depth":2},{"value":"createTable","id":"createtable","depth":3},{"value":"firstOfClassOrNew","id":"firstofclassornew","depth":3},{"value":"register","id":"register","depth":3},{"value":"unregister","id":"unregister","depth":3},{"value":"getDefaultAttributes","id":"getdefaultattributes","depth":3},{"value":"newCollection","id":"newcollection","depth":3},{"value":"getName","id":"getname","depth":3},{"value":"setName","id":"setname","depth":3},{"value":"run","id":"run","depth":3},{"value":"getPriority","id":"getpriority","depth":3},{"value":"setPriority","id":"setpriority","depth":3},{"value":"getDescription","id":"getdescription","depth":3},{"value":"setDescription","id":"setdescription","depth":3},{"value":"getFrequencyMinutes","id":"getfrequencyminutes","depth":3},{"value":"setFrequencyMinutes","id":"setfrequencyminutes","depth":3},{"value":"anticipatedNextRun","id":"anticipatednextrun","depth":3},{"value":"isEnabled","id":"isenabled","depth":3},{"value":"setEnabled","id":"setenabled","depth":3},{"value":"isPeriodic","id":"isperiodic","depth":3},{"value":"setPeriodic","id":"setperiodic","depth":3},{"value":"getStatus","id":"getstatus","depth":3},{"value":"getStatusAttribute","id":"getstatusattribute","depth":3},{"value":"status","id":"status","depth":3},{"value":"getSystemName","id":"getsystemname","depth":3},{"value":"getAccessLevel","id":"getaccesslevel","depth":3},{"value":"getOutputKeys","id":"getoutputkeys","depth":3},{"value":"isDailyTask","id":"isdailytask","depth":3},{"value":"monthlyDayOfExecution","id":"monthlydayofexecution","depth":3},{"value":"isSkipDailyCron","id":"isskipdailycron","depth":3},{"value":"getDetailUrl","id":"getdetailurl","depth":3},{"value":"getFailureUrl","id":"getfailureurl","depth":3}],"frontmatter":{"title":"WHMCS\\Scheduling\\Task\\AbstractTask","seo":{"title":"WHMCS\\Scheduling\\Task\\AbstractTask"}},"lastModified":"2026-08-05T14:37:16.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/classes/whmcs/scheduling/task/abstracttask","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}