WordPress.org

Ready to get started?Download WordPress

Plugin Directory

ThreeWP Activity Monitor

Track and display site or network-wide user activity.

Custom activities

Your plugin can both log activities it creates and [optionally] display them.

  1. First, use the filter threewp_activity_monitor_list_activities.
  2. Then log the activity using the threewp_activity_monitor_new_activity action.
  3. Then, optionally, you can handle the displaying of the activity yourself: filter threewp_activity_monitor_display_activity

action: threewp_activity_monitor_new_activity

do_action('threewp_activity_monitor_new_activity', array(
    'activity_id' => '25char_description',
    'activity_strings' => array(
        "" => "%user_display_name_with_link% removed a category on %blog_name_with_panel_link%",
        "Action key 1" => "The key is displayed as small, grey text in front of the other text. Something interesting happened and user # %user_id% caused it!",
        "  " => "%user_login% didnt want any header here so %user_login_with_link% left it blank with two spaces",
        "Another key!" => "This time I wanted a key on %blog_name% (%blog_id%).",
    ),
    ['user_data'] => $user_object,
    ['post_data'] => $post_object,
    ['comment_data'] => $comment_object,
    ['other_data'] => $any,
));

activity_id is the string to use as an index. See the _index table for the existing activity_id strings which you should avoid (comment_approve, login_success, etc). 25 chars max. *activity_strings* is a description of the activity. It is an array of key/header => value/text.

The key is the small, gray text. It can be left empty. If you want several empty keys, use a different amount of spaces for each one. The spaces are trimmed off. The value is the black text to be displayed to the right of the key or by itself on a line.

Both the key and value can be normal HTML and are both capable of keywords.

user_data is an optional user object, if you want the user-related keywords to work with other user data other than the logged-in user's. post_data is an optional post object that enables the post-related keywords. comment_data is an optional comment object that enables the comment-related keywords.

The following keywords are automatically replaced by Activity Monitor. Note that post and comment keywords only work when post_data or comment_data are specified.

  • %user_id% ID of user.
  • %user_login% User's login name.
  • %user_login_with_link% User's login name in link format (link goes to the user edit page).
  • %user_display_name% User's display name.
  • %user_display_name_with_link% User's display name in link format (link goes to the user edit page).
  • %user_display_name% User's login name.
  • %user_display_name_with_link% User's login name in link format (link goes to the user edit page).
  • %blog_id% ID of blog.
  • %blog_name% Name of blog.
  • %blog_link% Link to front page of blog.
  • %blog_panel_link% Link to blog's admin panel.
  • %blog_name_with_link% Blog's name with link to front page.
  • %blog_name_with_panel_link% Blog's name with link to admin panel.
  • %server_http_user_agent% User's web browser
  • %server_http_remote_host% User's hostname
  • %server_http_remote_addr% User's IP address
  • %post_title% The post's title
  • %post_link% The post's title
  • %post_title_with_link% The post's title
  • %comment_id% The comment's ID
  • %comment_link% The link to the comment
  • %comment_id_with_link% The comment's linked ID.

Any other data stored in the array is saved automatically. This array can later be retrieved and used for custom display using the filter: threewp_activity_monitor_display_activity

The activity is stored only if you've used threewp_activity_monitor_list_activities to allow the admin to log the activity at all.

filter: threewp_activity_monitor_list_activities

add_filter( 'threewp_activity_monitor_list_activities', array(&$this, 'list_activities'), 10, 2 );

public function list_activities($activities)
{
    // Create an array which we fill with out own activities.
    $this->activities = array(
        // The bare minimum needed: the key and an array with the name of the activity.
        'wp_login' => array(
            'name' => _('User login'),
        ),
        // And now one with all options set.
        'wp_login_failed' => array(
            'name' => _('User login failed'),
            'description' => _('Logs the password the user tried to login with.'),
            'sensitive' => true,
            'can_be_converted_to_post' => true,        // In this example, it can.
        ),
    );

    // Insert our module name in all the array values.
    // You can do this once, here, or several times manually in the above array.
    // After inserting the plugin name, insert the activity into the main $activities array.
    foreach( $this->activities as $index => $activity )
    {
        $activity['plugin'] = 'ThreeWP Activity Monitor';
        $activities[ $index ] = $activity;
    }

    // Return the complete array.
    return $activities;
}

filter: threewp_activity_monitor_display_custom_activity

add_filter( 'threewp_activity_monitor_display_activity', array(&$this, 'display_custom_activity'), 10, 1);

/**
    Inserts display info into the activity.

    The following options are available for display:

    Optional: a raw string.
    $activity['display_string'] => 'Is a completely unfiltered string.';

    Optional: strings with headings.
    $activity['display_strings'] = array(
        '' => 'No heading, text string.',
        ' ' => 'Another non-heading, displaying just this string.',
        'User ID' => 'The heading user id, and then this string',
        '   ' => 'More (trimmed) spaces means another non-heading',
    );

    If you want special classes appended to the activity's <tr>, append values to the display_tr_classes array.
    $activity['display_tr_classes'] = array('class1', 'class2');

    @param      array       $activity       Activity to be filled in.
    @return     array                       Activity with a combination of display_string, display_strings and display_tr_classes keys set.
**/
public function display_activity( $activity )
{
    switch( $activity['activity_id'] )
    {
        case 'custom_act_22':
            $activity['display_string'] = 'This string is outputted without much ado. No filtering or anything.';
            break;
        case 'user_exploded':
            $activity['display_strings'] = array_merge( array(
                '' => 'This is the first line, without a heading',
                'Good heading' => 'Is a the second line, with a very good heading',
            ), $activity['data']['activity_strings'] );
            $activity['display_string'] = 'This string is outputted without much ado. No filtering or anything.';

            $activity['display_strings']['Cows'] = 'The user has ' . $activity['data']['cow_count'] . ' cows available for purchase.';
            break;

    }
    return $activity;
}

filter: threewp_activity_monitor_find_activities

Get a list of semi-specific activities from the database.

Selection of exactly which activities you want is done using the where option in the array.

See the following example from ThreeWP Activity Monitor RSS Creator.

$activities = apply_filters( 'threewp_activity_monitor_find_activities', array (
    'where' => array(
        "activity_id" => "activity_id IN ('". implode("','", $feed['activities']) . "')",
        "blog_id" => "blog_id IN ('". implode("','", $feed['blogs']) . "')",
    ),
    'limit' => $feed['limit'],
));

This uses the filter to requests $feed[limit] amount of activities, that have the $feed[activities] activity_ids and from the $feed[blogs] blogs.

This returns an array of activities, which the plugin later uses and calls another filter: convert_activity_to_post, in order to display the activities as an RSS feed.

filter: threewp_activity_monitor_convert_activity_to_post

If your plugin creates activities that can be displayed to the user in the form of posts (eg: new posts, updated posts, new comments) then add a filter.

Return a complete post. The guid should be used as a link to the post or comment in question.

Requires: 3.3 or higher
Compatible up to: 3.4.2
Last Updated: 2014-5-20
Downloads: 46,679

Ratings

4 stars
4.7 out of 5 stars

Support

0 of 1 support threads in the last two months have been resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

0,1,0 0,1,0
0,1,0 0,1,0
0,1,0 0,1,0
100,1,1 100,1,1 0,1,0 0,1,0
0,1,0 0,1,0
33,3,1 0,1,0 0,1,0
100,1,1 0,1,0 0,1,0
0,1,0 0,1,0
50,2,1 0,1,0
100,1,1 0,1,0
0,1,0 100,2,2 0,1,0
0,2,0 50,2,1
100,1,1 0,1,0
50,2,1 0,1,0 0,1,0
67,3,2
100,1,1 17,6,1 100,3,3 100,1,1 33,3,1
100,1,1 40,5,2
71,7,5 100,2,2
100,1,1
100,1,1
67,3,2 100,1,1 100,2,2
100,1,1
50,2,1
92,12,11
100,3,3
100,2,2
100,2,2