Cron: clean-up activity older than 14 days.

See #25.

Author: JJJ

wp-user-activity.php

@@ -32,6 +32,7 @@ function _wp_user_activity() {
 	// Include the files
 	require_once $dir . 'includes/admin.php';
 	require_once $dir . 'includes/classes.php';
+	require_once $dir . 'includes/cron.php';
 	require_once $dir . 'includes/capabilities.php';
 	require_once $dir . 'includes/common.php';
 	require_once $dir . 'includes/list-table.php';

wp-user-activity/includes/cron.php

@@ -0,0 +1,110 @@
+<?php
+
+/**
+ * User Activity Cron
+ *
+ * @package User/Activity/Cron
+ */
+
+// Exit if accessed directly
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Schedule cron
+ *
+ * @since 2.3.0
+ * @return void
+ */
+function wp_user_activity_schedule_cron() {
+
+    // Define task name
+    $task = 'wp_user_activity_trash_old_activities';
+
+    // Schedule cron
+    if ( ! wp_next_scheduled( $task ) ) {
+        wp_schedule_event( time(), 'daily', $task );
+    }
+}
+
+/**
+ * Trash old activities
+ *
+ * This function is used to trash old activity items, both to keep the
+ * database clean and to improve performance.
+ *
+ * It is scheduled to run daily, and will trash a maximum of 100 items,
+ * but if it retrieves the maximum number of items, it will schedule the
+ * next cron to run in 60 seconds, effectively running the cron until
+ * there are no more items to trash.
+ *
+ * @since 2.3.0
+ * @return void
+ */
+function wp_user_activity_trash_old_activities() {
+
+    /**
+     * Filter the number of days to keep trashed activities
+     *
+     * @since 2.3.0
+     * @param int $days_to_keep The number of days to keep trashed activities
+     * @return int
+     */
+    $days_to_keep = (int) apply_filters( 'wp_user_activity_trash_days_to_keep', 14 );
+
+    /**
+     * Filter the time until the next cron loop
+     *
+     * @since 2.3.0
+     * @param int $time_until_next_cron The time until the next cron loop
+     * @return int
+     */
+    $time_until_next_cron = (int) apply_filters( 'wp_user_activity_trash_time', 60 );
+
+    /**
+     * Filter the maximum number of activities to trash each time
+     *
+     * @since 2.3.0
+     * @param int $max_trash_each_time The maximum number of activities to trash each time
+     * @return int
+     */
+    $max_trash_each_time = (int) apply_filters( 'wp_user_activity_trash_each', 100 );
+
+    // Date arguments
+    $date_args = array(
+        'before' => date( 'Y-m-d H:i:s', strtotime( "-{$days_to_keep} days" ) )
+    );
+
+    // Query arguments
+    $args = array(
+        'fields'         => 'ids',
+        'post_type'      => 'activity',
+        'post_status'    => 'publish',
+        'orderby'        => 'post_date',
+        'order'          => 'DESC',
+        'date_query'     => $date_args,
+        'posts_per_page' => $max_trash_each_time,
+    );
+
+    // Get activities
+    $activities = new WP_Query( $args );
+
+    // Name of the single event
+    $single = 'wp_user_activity_trash_old_activities_loop';
+
+    // Bail if no activities
+    if ( empty( $activities ) ) {
+        wp_clear_scheduled_hook( $single );
+        wp_clear_scheduled_hook( __FUNCTION__ );
+        return;
+    }
+
+    // Schedule next cron if we retrieved the max number of activities
+    if ( ( $activities->post_count === $max_trash_each_time ) && ! wp_next_scheduled( $single ) ) {
+        wp_schedule_single_event( time() + $time_until_next_cron, $single );
+    }
+
+    // Trash all activities
+    foreach ( $activities->posts as $activity_id ) {
+        wp_trash_post( $activity_id );
+    }
+}

wp-user-activity/includes/hooks.php

@@ -53,6 +53,11 @@
 // Untrash
 add_filter( 'wp_untrash_post_status', 'wp_user_activity_untrash_to_previous_status', 10, 3 );
 
+// Cron
+add_action( 'init',                                       'wp_user_activity_schedule_cron' );
+add_action( 'wp_user_activity_trash_old_activities',      'wp_user_activity_trash_old_activities' );
+add_action( 'wp_user_activity_trash_old_activities_loop', 'wp_user_activity_trash_old_activities' );
+
 // Admin only filter for list-table sorting
 if ( is_admin() ) {
 	add_filter( 'pre_get_posts', 'wp_user_activity_maybe_sort_by_fields'   );