NOTE: This feature is available starting from version 1.6.2.
By default, Estate Mailer Pro ships with 5 predefined statuses: Not Started, In Progress, Testing, Awaiting Feedback, and Complete. However, you can add new statuses using a simple action hook to fit your needs.
The statuses Not Started, Complete, and In Progress are core statuses, and you should not modify these to ensure everything works properly.
We assume you have some basic knowledge of reading PHP code for this article, but it won’t be too hard if you don’t. You can simply copy and paste the code and adjust the keys as needed (see the explanation of keys below).
In this example, you will add 2 new task statuses: On Hold and Ready For Production.
See below examples of code that you must add in the application/helpers/my_functions_helper.php file (create the file if it doesn’t exist).
<?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; }
The ID for each status must be unique.
- id – The ID of the task status. It is recommended to use a higher ID number to prevent overlapping with the default system IDs for task statuses. For example, if there are currently task statuses with IDs 1, 2, 3, 4, and 5, and in the future, a new default task status is added with ID 6, having your own status with ID 6 could cause issues. It is not recommended to change the ID once tasks are using the status ID.
- color – Color for this status in hex format.
- name – The name of the status that will be displayed to users.
- order – The order of the status, e.g., for Kanban order.
- filter_default – This option is used if you want to exclude tasks with this status from being included in the lists by default. For example, if this option is set to false, when you access the Tasks lists area (main tasks lists or related), tasks with this status won’t be shown by default, and you will need to manually use the filters to include them in the table. A simple example is if you add a status Cancelled, you won’t want cancelled tasks to be shown by default in the table.
After you adjust the code to fit your needs, save the my_functions_helper.php file, and you will be able to see your new task statuses.
