Shortcodes

Display Asana tasks on your website to improve work transparency and collaboration—while reducing users within your Asana workspace.

Table of Contents

1. Caching
   1. Changing the cache TTL
   2. Clearing the cache
2. Untitled Project Sections
3. [ptc_asana_project]

Caching

Frontend requests are cached by default for 15 minutes. This improves website performance by reducing the frequency that data is requested from Asana.

Changing the cache TTL

If you find that Asana data is not being updated often enough, you may implement the following filter hook.

This reduces the cache duration to 5 minutes:

add_filter( 'ptc_completionist_request_tokens_ttl', 'ptc_get_request_tokens_ttl', 10, 1 );
function ptc_get_request_tokens_ttl( $ttl ) {
  return 5 * MINUTE_IN_SECONDS;
}

You may also increase the cache duration, such as using 1 hour:

add_filter( 'ptc_completionist_request_tokens_ttl', 'ptc_get_request_tokens_ttl', 10, 1 );
function ptc_get_request_tokens_ttl( $ttl ) {
  return HOUR_IN_SECONDS;
}

Refer to WordPress’s PHP time constants for other duration expressions.

Clearing the cache

Cache entries relate to each WordPress post that contains Completionist shortcodes and are stored on an individual basis as postmeta. For this reason, cache entries are purged for a post whenever it is updated.

To purge all cache entries across all posts, simply click Save next to the Frontend Authentication User option in Completionist’s Settings screen.

Untitled Project Sections

Despite an Asana project seeming to have untitled sections or no sections at all, the Asana API provides these sections with placeholder names. To display the same experience, Completionist ignores those placeholder names.

By default, Completionist does not display these section titles:

• (no section)
• Untitled section

You may choose to override which project section names are ignored by filtering the list of erased names. The Asana project’s GID and request configuration arguments are also provided for context.

This will allow all section names to be displayed, including Asana’s placeholder names:

add_filter( 'ptc_completionist_project_section_names_to_erase', 'ptc_get_project_section_names_to_erase', 10, 3 );
function ptc_get_project_section_names_to_erase( $names, $project_gid, $args ) {
  return array();
}

This will add another section name to be erased:

add_filter( 'ptc_completionist_project_section_names_to_erase', 'ptc_get_project_section_names_to_erase', 10, 3 );
function ptc_get_project_section_names_to_erase( $names, $project_gid, $args ) {
  $names[] = 'Section Name';
  return $names;
}

[ptc_asana_project]

Displays Asana project information and tasks.

Attributes:

• src – Required. The Asana project link.
  • When viewing a project in Asana, copy the URL in the web browser address bar (eg. https://app.asana.com/0/1234567890/list) or the URL from clicking “Copy project link” in the project’s detail dropdown (eg. https://app.asana.com/0/1234567890/1234567890).
• auth_user – Optional. A WordPress user’s ID to authenticate the Asana API requests.
  • By default, the Frontend Authentication User saved in Completionist’s settings is used.
  • The WordPress user must be connected to Asana via Completionist in wp-admin, or you may see a 401 Unauthorized error on your website.
• show_name – Optional. Set to “false” to hide the project’s name. Default “true”.
• show_description – Optional. Set to “false” to hide the project’s description. Default “true”.
• show_status – Optional. Set to “false” to hide the project’s current status update and completion status. Default “true”.
• show_modified – Optional. Set to “false” to hide the project’s last modified date and time. Default “true”.
• show_due – Optional. Set to “false” to hide the project’s due date. Default “true”.
• show_tasks_description – Optional. Set to “false” to hide tasks’ descriptions. Default “true”.
• show_tasks_assignee – Optional. Set to “false” to hide tasks’ assignee. Default “true”.
• show_tasks_subtasks – Optional. Set to “false” to hide tasks’ subtasks. Default “true”.
  • Note that only the immediate subtasks are ever displayed. Subtasks of subtasks are never displayed.
• show_tasks_completed – Optional. Set to “false” to hide completed tasks. Default “true”.
  • If enabled, completed tasks will be shown (if any) and all “checkmark bubbles” will be displayed.
  • This setting also applies to subtasks.
• show_tasks_due – Optional. Set to “false” to hide tasks’ due dates. Default “true”.
• show_tasks_attachments – Optional. Set to “false” to hide tasks’ additional attachments. Default “true”.
  • Inline attachments in the tasks’ descriptions will still be displayed if show_tasks_description="true".
  • Currently, images are the only supported types of attachments.

Quick Copy:

[ptc_asana_project src="<ASANA_PROJECT_URL>" auth_user="" show_name="true" show_description="true" show_status="true" show_modified="true" show_due="true" show_tasks_description="true" show_tasks_assignee="true" show_tasks_subtasks="true" show_tasks_completed="true" show_tasks_due="true" show_tasks_attachments="true"]

Remember to set the src attribute to the URL of the Asana project that you’d like to display!