Action Hooks

Table of Contents

Zephyr Project Manager allows you to hook into the following actions documented below:

New project #

Action: zpm_new_project

Fires when a new project is created

Usage:

add_action('zpm_new_project', 'zpm_new_project_callback');

function zpm_new_project_callback ($project) {
	// $project: The project object containing the details. You can get the name id, name, description and more with $project->id, $project->name, $project->description etc.
}

Project Deleted #

Action: zpm_project_deleted

Fires when a project is deleted

Usage:

add_action('zpm_project_deleted', 'zpm_project_deleted_callback');

function zpm_project_deleted_callback ($project) {
	// $project: The project object containing the details. You can get the name id, name, description and more with $project->id, $project->name, $project->description etc.
}

Project Completed #

Action: zpm_project_completed

Fires when all the tasks within a project are completed, making the project complete

Usage:

add_action('zpm_project_completed', 'zpm_project_completed_callback');

function zpm_project_completed_callback ($project) {
	// $project: The project object containing the details. You can get the name id, name, description and more with $project->id, $project->name, $project->description etc.
}

Project Assigned #

Action: zpm_project_assigned

Fires when a project is assigned to someone

Usage:

add_action('zpm_project_assigned', 'zpm_project_assigned_callback');

function zpm_project_assigned_callback ($project, $assignees) {
	// $project: The project object containing the details. You can get the name id, name, description and more with $project->id, $project->name, $project->description etc.// $assignees: An associative array of all assigned users.
}

Project Status Changed #

Action: zpm_project_status_changed

Fires when a projects status changes

Usage:

add_action('zpm_project_status_changed', 'zpm_project_status_changed_callback');

function zpm_project_status_changed_callback ($data) {
	// $data: An array containing the project 'id', 'status' and 'color' of the new status
}

Project Copied #

Action: zpm_copy_project

Fires when a project is copied

Usage:

add_action('zpm_copy_project', 'zpm_copy_project_callback');

function zpm_copy_project_callback ($projectID, $prevID) {
	// $projectID: ID of the new copy project// $prevID: ID of the project that is being copied
}

New Task Created #

Action: zpm_new_task

Fires when a new task is created

Usage:

add_action('zpm_new_task', 'zpm_new_task_callback');

function zpm_new_task_callback ($task) {
	// $task: An object containing the new task data, such as the 'name', 'id' and 'description'
}

Task Updated #

Action: zpm_task_updated

Fires when a task is updated or edited

Usage:

add_action('zpm_task_updated', 'zpm_task_updated_callback');

function zpm_task_updated_callback ($task) {
	// $task: An object containing the new task data, such as the 'name', 'id' and 'description'
}

Task Deleted #

Action: zpm_task_deleted

Fires when a task is deleted

Usage:

add_action('zpm_task_deleted', 'zpm_task_deleted_callback');

function zpm_task_deleted_callback ($taskID) {
	// $taskID: ID of the deleted task
}

Task Completed #

Action: zpm_task_completed

Fires when a task is completed

Usage:

add_action('zpm_task_completed', 'zpm_task_completed_callback');

function zpm_task_completed_callback ($task) {
	// $task: An object containing the new task data, such as the 'name', 'id' and 'description'
}

Task Status Changed #

Action: zpm_task_status_changed

Fires when a tasks status is changed

Usage:

add_action('zpm_task_status_changed', 'zpm_task_status_changed_callback');

function zpm_task_status_changed_callback ($taskID, $status) {
	// $taskID: ID of the deleted task// $status: The new status
}
Was this helpful?