SureDash

https://suredash.com/docs
Admin
SureDash is a platform's knowledge base, offering articles and guides on various topics including...
Tokens:68,779
Snippets:1,562
Trust Score:7.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Notification Template

Source: https://suredash.com/docs/notifications-system-in-suredash

Use dynamic tags like {{user_first_name}}, {{portal_name}}, or {{portal_url}} to personalize each message. This template shows a basic welcome message structure.

```text
Hi {{user_first_name}},

Welcome to {{portal_name}}! 

```

--------------------------------

### Listen for Course Completion Hook

Source: https://suredash.com/docs/course-progress-hooks

Use this action hook to execute custom code when a user completes an entire course. It provides course ID and user ID.

```php
add_action( 'suredash_course_completed', function( $course_id, $user_id ) {
    // Example: Send data to a CRM
    // Example: Apply a tag
    // Example: Trigger a webhook
});
```

--------------------------------

### Add Members Directory Link to Profile Menu

Source: https://suredash.com/docs/how-to-set-up-members-directory-suredash

Use this dynamic tag to link directly to the Members Directory within your SureDash portal. Ensure SureDash 1.8.0 or above is installed.

```text
[members-directory]
```

--------------------------------

### Listen for Lesson Completion Hook

Source: https://suredash.com/docs/course-progress-hooks

Use this action hook to execute custom code when a user completes a lesson. It provides lesson ID, course ID, and user ID.

```php
add_action( 'suredash_lesson_completed', function( $lesson_id, $course_id, $user_id ) {
    // Example: Send data to a CRM
    // Example: Apply a tag
    // Example: Trigger a webhook
});
```

--------------------------------

### Hide Specific Users by User ID

Source: https://suredash.com/docs/hide-users-from-member-directory

Use this filter to exclude individual users from the member directory by their WordPress user ID. Replace the example IDs with the actual IDs of users you wish to hide.

```php
<?php
/**
 * Exclude specific users from the SureDash Member Directory.
 *
 * @param int[] $user_ids Existing list of user IDs to exclude.
 * @return int[] Updated list of user IDs to exclude.
 */
add_filter( 'suredash_membership_directory_excluded_user_ids', function ( $user_ids ) {
    // Replace 12 and 47 with the user IDs you want to hide.
    return array_merge( $user_ids, [ 12, 47 ] );
} );

```

--------------------------------

### After a Lesson is Completed

Source: https://suredash.com/docs/ottokit-hooks-reference

Fires when a user completes a lesson. It provides the lesson ID, course ID, and the user ID.

```APIDOC
## After a Lesson is Completed

### Description
Fires when a user completes a lesson.

### Hook Name
`suredash_lesson_completed`

### Parameters
- `$lesson_id` (int) - Lesson ID.
- `$course_id` (int) - Course ID.
- `$current_user` (int) - ID of the user who completed the lesson.
```

--------------------------------

### Hook: After Creating Post Content for Space

Source: https://suredash.com/docs/ottokit-hooks-reference

Fires when a new post or community content is created inside a space. Provides post ID, space ID, post type, and space type.

```php
do_action( 'suredash_after_creating_post_content_for_space', $post_id, $space_id, $post_type, $space_type );
```

--------------------------------

### After Creating Post Content for a Space

Source: https://suredash.com/docs/ottokit-hooks-reference

Fires when a new post or community content is created inside a space. It provides post ID, space ID, post type, and space type.

```APIDOC
## After Creating Post Content for a Space

### Description
Fires when a new post or community content is created inside a space.

### Parameters
#### Path Parameters
- **$post_id** (integer) - Required - Post ID.
- **$space_id** (integer) - Required - Space ID.
- **$post_type** (string) - Required - Post type (Community Post or Community Content).
- **$space_type** (string) - Required - Space type (‘resource_library’, ‘events’, or ‘course’).

### Code Example
```php
do_action( 'suredash_after_creating_post_content_for_space', $post_id, $space_id, $post_type, $space_type );
```
```

--------------------------------

### Customize Lesson, Resource, and Event Post Slugs

Source: https://suredash.com/docs/customize-community-content-post-slugs

Use these filters in your theme's functions.php or a custom plugin to change the default slugs for lessons, resources, and events. Remember to flush permalinks after applying these changes.

```php
add_filter( 'suredash_community_content_post_lesson_slug', function ( $slug ) {
    return 'ls'; // For "lesson" slug.
} );

add_filter( 'suredash_community_content_post_resource_slug', function ( $slug ) {
    return 'rs'; // For "resource" slug.
} );

add_filter( 'suredash_community_content_post_event_slug', function ( $slug ) {
    return 'ev'; // For "event" slug.
} );
```

--------------------------------

### After a Course is Completed

Source: https://suredash.com/docs/ottokit-hooks-reference

Fires when a user completes a course. It provides the course ID and the user ID.

```APIDOC
## After a Course is Completed

### Description
Fires when a user completes a course.

### Hook Name
`suredash_course_completed`

### Parameters
- `$course_id` (int) - Course ID.
- `$current_user` (int) - ID of the user who completed the course.
```

--------------------------------

### Hook: Item Bookmarking

Source: https://suredash.com/docs/ottokit-hooks-reference

Fires when a user bookmarks or un-bookmarks an item. Includes item ID, type, status, and user ID.

```php
do_action( 'suredash_item_bookmark', $item_id, $item_type, $status, $user_id );
```

--------------------------------

### Hook: After Community Content Deleted

Source: https://suredash.com/docs/ottokit-hooks-reference

Fires when any community content (lesson, resource, or event) is deleted. Provides the ID of the deleted content post.

```php
do_action( 'suredash_community_content_deleted', $content_post_id );
```

--------------------------------

### Trigger After Lesson Completion

Source: https://suredash.com/docs/ottokit-hooks-reference

Fires when a user completes a lesson. Use this hook to trigger actions based on lesson progress.

```php
do_action( 'suredash_lesson_completed', $lesson_id, $course_id, $current_user );
```
Tokens:
Raw