Add New Task Status

NOTE: This feature is available starting from version 1.6.2

By default, SudoWorkspace ships with 5 predefined statuses: Not Started, In Progress, Testing, Awaiting Feedback, and Complete, but you can inject new statuses with a simple action hook to fit your needs.

We assume that you have some basic knowledge of reading php code for this article, but it won’t be that hard if you don’t have it. You can just copy and paste the code and adjust the keys for your needs (see below key explanation).

In this example, you will add 2 new task statuses with names On Hold and Ready For Production

In application/helpers a create file my_functions_helper.php and add the following code:

application/helpers

my_functions_helper.php

<?php
// Version 2.3.0 and above
hooks()->add_filter('before_get_task_statuses','my_add_custom_task_status');
// Prior to version 2.3.0
// Uncomment the code below and remove the code above if you are using version older then 2.3.0
// add_action('before_get_task_statuses','my_add_custom_task_status');
function my_add_custom_task_status($current_statuses){
    // Push new status to the current statuses
    $current_statuses[] = array(
           'id'=>50, // new status with id 50
           'color'=>'#989898',
           'name'=>'On Hold',
           'order'=>10,
           'filter_default'=>true, // true or false
);
    // Push another status (delete this code if you need to add only 1 status)
    $current_statuses[] = array(
          'id'=>51, //new status with new id 51
          'color'=>'#be51e0',
          'name'=>'Ready For Production',
          'order'=>11,
          'filter_default'=>true // true or false
        );
// Return the statuses
    return $current_statuses;
}

<?php
// Version 2.3.0 and above
hooks()->add_filter('before_get_task_statuses','my_add_custom_task_status');
// Prior to version 2.3.0
// Uncomment the code below and remove the code above if you are using version older then 2.3.0
// add_action('before_get_task_statuses','my_add_custom_task_status');
function my_add_custom_task_status($current_statuses){
    // Push new status to the current statuses
    $current_statuses[] = array(
           'id'=>50, // new status with id 50
           'color'=>'#989898',
           'name'=>'On Hold',
           'order'=>10,
           'filter_default'=>true, // true or false
);
    // Push another status (delete this code if you need to add only 1 status)
    $current_statuses[] = array(
          'id'=>51, //new status with new id 51
          'color'=>'#be51e0',
          'name'=>'Ready For Production',
          'order'=>11,
          'filter_default'=>true // true or false
        );
// Return the statuses
    return $current_statuses;
}

<?php
// Version 2.3.0 and above
hooks()->add_filter('before_get_task_statuses','my_add_custom_task_status');
// Prior to version 2.3.0
// Uncomment the code below and remove the code above if you are using version older then 2.3.0
// add_action('before_get_task_statuses','my_add_custom_task_status');
function my_add_custom_task_status($current_statuses){
    // Push new status to the current statuses
    $current_statuses[] = array(
           'id'=>50, // new status with id 50
           'color'=>'#989898',
           'name'=>'On Hold',
           'order'=>10,
           'filter_default'=>true, // true or false
);
    // Push another status (delete this code if you need to add only 1 status)
    $current_statuses[] = array(
          'id'=>51, //new status with new id 51
          'color'=>'#be51e0',
          'name'=>'Ready For Production',
          'order'=>11,
          'filter_default'=>true // true or false
        );
// Return the statuses
    return $current_statuses;
}

• id – The ID of the task status. Use a higher ID value to avoid conflicts with the system’s default status IDs. For example, defaults currently use IDs 1–5; if a future default is assigned ID 6 and you have already assigned ID 6 to a custom status, this can cause problems. Do not change an ID after tasks are already using that status.
• color – The color representing this status, specified in hexadecimal format (e.g., #FF0000).
• name – The label displayed to users for this status.
• order – The display order of the status (for example, its position in Kanban columns).
• filter_default – Controls whether tasks with this status are included in lists by default. If false, tasks using this status are excluded from task lists (main or related) and must be included manually via filters. For example, you may not want tasks marked ‘Cancelled’ to appear in lists by default.

my_functions_helper.php