# s2member/260805/src/includes/classes/auto-eots.inc.php

s2Member – Excellent for All Kinds of Memberships, Content Restriction Paywalls & Member Access Subscriptions, version 260805. 332 lines.

- Page: https://pluginprobe.com/plugins/s2member/260805/code/src/includes/classes/auto-eots.inc.php
- Raw: https://pluginprobe.com/plugins/s2member/260805/raw/src/includes/classes/auto-eots.inc.php
- Modified: 2026-05-08T01:02:04+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/s2member/260805/code/src/includes/classes/auto-eots.inc.php#L10-L20`.

```php
<?php
// @codingStandardsIgnoreFile
/**
 * s2Member's Auto-EOT System *(EOT = End Of Term)*.
 *
 * Copyright: © 2009-2011
 * {@link http://websharks-inc.com/ WebSharks, Inc.}
 * (coded in the USA)
 *
 * Released under the terms of the GNU General Public License.
 * You should have received a copy of the GNU General Public License,
 * along with this software. In the main directory, see: /licensing/
 * If not, see: {@link http://www.gnu.org/licenses/}.
 *
 * @package s2Member\Auto_EOT_System
 * @since 3.5
 */
if(!defined('WPINC')) // MUST have WordPress.
	exit ('Do not access this file directly.');

if(!class_exists('c_ws_plugin__s2member_auto_eots'))
{
	/**
	 * s2Member's Auto-EOT System *(EOT = End Of Term)*.
	 *
	 * @package s2Member\Auto_EOT_System
	 * @since 3.5
	 */
	class c_ws_plugin__s2member_auto_eots
	{
		/**
		 * Adds a scheduled task for s2Member's Auto-EOT System.
		 *
		 * @package s2Member\Auto_EOT_System
		 * @since 3.5
		 *
		 * @return bool True if able to add Auto-EOT System schedule, else false.
		 */
		public static function add_auto_eot_system()
		{
			do_action('ws_plugin__s2member_before_add_auto_eot_system', get_defined_vars());

			if(!c_ws_plugin__s2member_auto_eots::delete_auto_eot_system())
			{
				return apply_filters('ws_plugin__s2member_add_auto_eot_system', FALSE, get_defined_vars());
			}
			else if(function_exists('wp_cron') /* Otherwise, we can schedule? */)
			{
				wp_schedule_event(time(), 'every10m', 'ws_plugin__s2member_auto_eot_system__schedule');

				return apply_filters('ws_plugin__s2member_add_auto_eot_system', TRUE, get_defined_vars());
			}
			else // Otherwise, it would appear that WP-Cron is not available.
			{
				return apply_filters('ws_plugin__s2member_add_auto_eot_system', FALSE, get_defined_vars());
			}
		}

		/**
		 * Deletes all scheduled tasks for s2Member's Auto-EOT System.
		 *
		 * @package s2Member\Auto_EOT_System
		 * @since 3.5
		 *
		 * @return bool True if able to delete Auto-EOT System schedule, else false.
		 */
		public static function delete_auto_eot_system()
		{
			do_action('ws_plugin__s2member_before_delete_auto_eot_system', get_defined_vars());

			if(function_exists('wp_cron') /* Is `wp_cron()` even available? */)
			{
				wp_clear_scheduled_hook('ws_plugin__s2member_auto_eot_system__schedule' /* Since v3.0.3. */);

				return apply_filters('ws_plugin__s2member_delete_auto_eot_system', TRUE, get_defined_vars());
			}
			else // Otherwise, it would appear that WP-Cron is not available.
			{
				return apply_filters('ws_plugin__s2member_delete_auto_eot_system', FALSE, get_defined_vars());
			}
		}

		/**
		 * Processed by WP_Cron; this handles Auto-EOTs *(EOT = End Of Term)*.
		 *
		 * If you have a HUGE userbase, increase the max EOTs per process.
		 * But NOTE, this runs ``$per_process`` *(per Blog)* on a Multisite Network.
		 * To increase, use: ``add_filter ('ws_plugin__s2member_auto_eot_system_per_process');``.
		 *
		 * This function makes an important Hook available: `ws_plugin__s2member_after_auto_eot_system`.
		 * This Hook is used by some of s2Member Pro's Gateway integrations; allowing CRON processing
		 * to run for important communications; which poll Payment Gateway APIs for possible EOTs.
		 *
		 * @package s2Member\Auto_EOT_System
		 * @since 3.5
		 *
		 * @param int $per_process Number of database records to process each time.
		 *   Can also be Filtered with `ws_plugin__s2member_auto_eot_system_per_process`.
		 *
		 * @return null
		 */
		public static function auto_eot_system($per_process = 6)
		{
			global $wpdb;
			/** @var $wpdb \wpdb */
			global $current_site, $current_blog;

			include_once ABSPATH.'wp-admin/includes/admin.php';

			@set_time_limit(0); // Make time for processing a larger userbase.
			@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));

			foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
			do_action('ws_plugin__s2member_before_auto_eot_system', get_defined_vars());
			unset($__refs, $__v); // Housekeeping.

			if($GLOBALS['WS_PLUGIN__']['s2member']['o']['auto_eot_system_enabled']  /* Enabled? */)
			{
				$per_process = apply_filters('ws_plugin__s2member_auto_eot_system_per_process', $per_process, get_defined_vars());

				//260414 Ignore zero/negative Auto-EOT values here. We had real PayPal Pro subscribers demoted
				// because a stored `s2member_auto_eot_time` of `0` matched the old `<= now` query.
				if(is_array($eots = $wpdb->get_results("SELECT `user_id` AS `ID` FROM `".$wpdb->usermeta."` WHERE `meta_key` = '".$wpdb->prefix."s2member_auto_eot_time' AND `meta_value` != '' AND `meta_value` > '0' AND `meta_value` <= '".esc_sql(strtotime("now"))."' LIMIT ".$per_process)))
				{
					foreach($eots as $eot) // Go through the array of EOTS. We need to (demote|delete) each of them.
					{
						if(($user_id = $eot->ID) && is_object($user = new WP_User ($user_id)) && $user->ID)
						{
							$auto_eot_time = (integer)get_user_option('s2member_auto_eot_time', $user_id);

							$log_entry = array('user' => (array)$user); // Intialize.
							$log_entry['auto_eot_time'] = $auto_eot_time; // Record EOT time.

							//260414 Keep a minimal pre-demotion subscription snapshot in the log so we can tell later
							// whether this member still had subscription metadata before anything was cleared.
							$log_entry['subscr_gateway'] = get_user_option('s2member_subscr_gateway', $user_id);
							$log_entry['subscr_id'] = get_user_option('s2member_subscr_id', $user_id);
							$log_entry['has_ipn_signup_vars'] = is_array(get_user_option('s2member_ipn_signup_vars', $user_id)) ? 'yes' : 'no';

							//260414 Defense in depth. A bad stored value of `0` caused false demotions in the wild.
							// If one still reaches this loop for any reason, log it and skip instead of clearing fields.
							if($auto_eot_time <= 0)
							{
								$log_entry['auto_eot_skip_reason'] = 'Skipped. Stored `s2member_auto_eot_time` was <= 0.';
								c_ws_plugin__s2member_utils_logs::log_entry('auto-eot-system', $log_entry);
								continue;
							}

							delete_user_option($user_id, 's2member_last_auto_eot_time');
							delete_user_option($user_id, 's2member_auto_eot_time');

							if(!$user->has_cap('administrator') /* Do NOT process Administrator accounts. */)
							{
								if($GLOBALS['WS_PLUGIN__']['s2member']['o']['membership_eot_behavior'] === 'demote')
								{
									$eot_del_type = 'auto-eot-cancellation-expiration-demotion'; // Set EOT/Del type.
									$log_entry['eot_del_type'] = $eot_del_type; // Deleting user in this case.

									$custom          = get_user_option('s2member_custom', $user_id);
									$subscr_gateway  = get_user_option('s2member_subscr_gateway', $user_id);
									$subscr_id       = get_user_option('s2member_subscr_id', $user_id);
									$subscr_baid     = get_user_option('s2member_subscr_baid', $user_id);
									$subscr_cid      = get_user_option('s2member_subscr_cid', $user_id);
									$fields          = get_user_option('s2member_custom_fields', $user_id);
									$user_reg_ip     = get_user_option('s2member_registration_ip', $user_id);
									$ipn_signup_vars = get_user_option('s2member_ipn_signup_vars', $user_id);

									$demotion_role = c_ws_plugin__s2member_option_forces::force_demotion_role('subscriber');
									$existing_role = c_ws_plugin__s2member_user_access::user_access_role($user);

									foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
									do_action('ws_plugin__s2member_during_auto_eot_system_during_before_demote', get_defined_vars());
									do_action('ws_plugin__s2member_during_collective_mods', $user_id, get_defined_vars(), $eot_del_type, 'modification', $demotion_role);
									do_action('ws_plugin__s2member_during_collective_eots', $user_id, get_defined_vars(), $eot_del_type, 'modification');
									unset($__refs, $__v); // Housekeeping.

									if($existing_role !== $demotion_role /* Only if NOT the existing Role. */)
										$user->set_role($demotion_role /* Give User the demotion Role. */);

									if(apply_filters('ws_plugin__s2member_remove_ccaps_during_eot_events', (bool)$GLOBALS['WS_PLUGIN__']['s2member']['o']['eots_remove_ccaps'], get_defined_vars()))
										foreach($user->allcaps as $cap => $cap_enabled)
											if(preg_match('/^access_s2member_ccap_/', $cap))
												$user->remove_cap($ccap = $cap);

									delete_user_option($user_id, 's2member_subscr_gateway');
									delete_user_option($user_id, 's2member_subscr_id');
									delete_user_option($user_id, 's2member_subscr_baid');
									delete_user_option($user_id, 's2member_subscr_cid');

									delete_user_option($user_id, 's2member_ipn_signup_vars');
									if(!apply_filters('ws_plugin__s2member_preserve_paid_registration_times', TRUE))
										delete_user_option($user_id, 's2member_paid_registration_times');

									delete_user_option($user_id, 's2member_last_status_scan');
									delete_user_option($user_id, 's2member_first_payment_txn_id');
									delete_user_option($user_id, 's2member_last_payment_time');
									delete_user_option($user_id, 's2member_last_auto_eot_time');
									delete_user_option($user_id, 's2member_auto_eot_time');

									delete_user_option($user_id, 's2member_file_download_access_log');
									delete_user_option($user_id, 's2member_authnet_payment_failures');

									update_user_option($user_id, 's2member_last_auto_eot_time', $auto_eot_time);

									c_ws_plugin__s2member_user_notes::append_user_notes($user_id, 'Demoted by s2Member: '.date('D M j, Y g:i a T'));
									if($subscr_gateway && $subscr_id) // Also note the Paid Subscr. Gateway/ID so there is a reference left behind here.
										c_ws_plugin__s2member_user_notes::append_user_notes($user_id, 'Paid Subscr. ID @ time of demotion: '.$subscr_gateway.' → '.$subscr_id);

									if($GLOBALS['WS_PLUGIN__']['s2member']['o']['eot_del_notification_urls'])
									{
										foreach(preg_split('/['."\r\n\t".']+/', $GLOBALS['WS_PLUGIN__']['s2member']['o']['eot_del_notification_urls']) as $url) // Handle EOT Notifications.

											if(($url = c_ws_plugin__s2member_utils_strings::fill_cvs($url, $custom, true)) && ($url = preg_replace('/%%eot_del_type%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode('auto-eot-cancellation-expiration-demotion')), $url)) && ($url = preg_replace('/%%subscr_id%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode($subscr_id)), $url)))
												if(($url = preg_replace('/%%user_first_name%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode($user->first_name)), $url)) && ($url = preg_replace('/%%user_last_name%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode($user->last_name)), $url)))
													if(($url = preg_replace('/%%user_full_name%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode(trim($user->first_name.' '.$user->last_name))), $url)))
														if(($url = preg_replace('/%%user_email%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode($user->user_email)), $url)))
															if(($url = preg_replace('/%%user_login%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode($user->user_login)), $url)))
																if(($url = preg_replace('/%%user_ip%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode($user_reg_ip)), $url)))
																	if(($url = preg_replace('/%%user_id%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode($user_id)), $url)))
																	{
																		if(is_array($fields) && !empty($fields))
																			foreach($fields as $var => $val /* Custom Registration/Profile Fields. */)
																				if(!($url = preg_replace('/%%'.preg_quote($var, '/').'%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(urlencode(maybe_serialize($val))), $url)))
																					break;

																		if(($url = trim(preg_replace('/%%(.+?)%%/i', '', $url))))
																			c_ws_plugin__s2member_utils_urls::remote($url);
																	}
									}
									if($GLOBALS['WS_PLUGIN__']['s2member']['o']['eot_del_notification_recipients'])
									{
										$email_configs_were_on = c_ws_plugin__s2member_email_configs::email_config_status();
										c_ws_plugin__s2member_email_configs::email_config_release();

										$msg = $sbj = '(s2Member / API Notification Email) - EOT/Deletion';
										$msg .= "\n\n"; // Spacing in the message body.

										$msg .= 'eot_del_type: %%eot_del_type%%'."\n";
										$msg .= 'subscr_id: %%subscr_id%%'."\n";
										$msg .= 'subscr_baid: %%subscr_baid%%'."\n";
										$msg .= 'subscr_cid: %%subscr_cid%%'."\n";
										$msg .= 'user_first_name: %%user_first_name%%'."\n";
										$msg .= 'user_last_name: %%user_last_name%%'."\n";
										$msg .= 'user_full_name: %%user_full_name%%'."\n";
										$msg .= 'user_email: %%user_email%%'."\n";
										$msg .= 'user_login: %%user_login%%'."\n";
										$msg .= 'user_ip: %%user_ip%%'."\n";
										$msg .= 'user_id: %%user_id%%'."\n";

										if(is_array($fields) && !empty($fields))
											foreach($fields as $var => $val)
												$msg .= $var.': %%'.$var.'%%'."\n";

										$msg .= 'cv0: %%cv0%%'."\n";
										$msg .= 'cv1: %%cv1%%'."\n";
										$msg .= 'cv2: %%cv2%%'."\n";
										$msg .= 'cv3: %%cv3%%'."\n";
										$msg .= 'cv4: %%cv4%%'."\n";
										$msg .= 'cv5: %%cv5%%'."\n";
										$msg .= 'cv6: %%cv6%%'."\n";
										$msg .= 'cv7: %%cv7%%'."\n";
										$msg .= 'cv8: %%cv8%%'."\n";
										$msg .= 'cv9: %%cv9%%';

										if(($msg = c_ws_plugin__s2member_utils_strings::fill_cvs($msg, $custom)) && ($msg = preg_replace('/%%eot_del_type%%/i', c_ws_plugin__s2member_utils_strings::esc_refs('auto-eot-cancellation-expiration-demotion'), $msg)) && ($msg = preg_replace('/%%subscr_id%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($subscr_id), $msg)))
											if(($msg = preg_replace('/%%subscr_baid%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($subscr_baid), $msg)) && ($msg = preg_replace('/%%subscr_cid%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($subscr_cid), $msg)))
												if(($msg = preg_replace('/%%user_first_name%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($user->first_name), $msg)) && ($msg = preg_replace('/%%user_last_name%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($user->last_name), $msg)))
													if(($msg = preg_replace('/%%user_full_name%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(trim($user->first_name.' '.$user->last_name)), $msg)))
														if(($msg = preg_replace('/%%user_email%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($user->user_email), $msg)))
															if(($msg = preg_replace('/%%user_login%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($user->user_login), $msg)))
																if(($msg = preg_replace('/%%user_ip%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($user_reg_ip), $msg)))
																	if(($msg = preg_replace('/%%user_id%%/i', c_ws_plugin__s2member_utils_strings::esc_refs($user_id), $msg)))
																	{
																		if(is_array($fields) && !empty($fields))
																			foreach($fields as $var => $val /* Custom Registration/Profile Fields. */)
																				if(!($msg = preg_replace('/%%'.preg_quote($var, '/').'%%/i', c_ws_plugin__s2member_utils_strings::esc_refs(maybe_serialize($val)), $msg)))
																					break;

																		if($sbj && ($msg = trim(preg_replace('/%%(.+?)%%/i', '', $msg))) /* Still have a ``$sbj`` and a ``$msg``? */)

																			foreach(c_ws_plugin__s2member_utils_strings::parse_emails($GLOBALS['WS_PLUGIN__']['s2member']['o']['eot_del_notification_recipients']) as $recipient)
																				wp_mail($recipient, apply_filters('ws_plugin__s2member_eot_del_notification_email_sbj', $sbj, get_defined_vars()), apply_filters('ws_plugin__s2member_eot_del_notification_email_msg', $msg, get_defined_vars()), 'Content-Type: text/plain; charset=UTF-8');
																	}
										if($email_configs_were_on) c_ws_plugin__s2member_email_configs::email_config();
									}
									foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
									do_action('ws_plugin__s2member_during_auto_eot_system_during_demote', get_defined_vars());
									unset($__refs, $__v); // Housekeeping.
								}
								else if($GLOBALS['WS_PLUGIN__']['s2member']['o']['membership_eot_behavior'] === 'delete')
								{
									$eot_del_type = $GLOBALS['ws_plugin__s2member_eot_del_type'] = 'auto-eot-cancellation-expiration-deletion';
									$log_entry['eot_del_type'] = $eot_del_type; // Deleting user in this case.

									foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
									do_action('ws_plugin__s2member_during_auto_eot_system_during_before_delete', get_defined_vars());
									do_action('ws_plugin__s2member_during_collective_eots', $user_id, get_defined_vars(), $eot_del_type, 'removal-deletion');
									unset($__refs, $__v); // Housekeeping.

									if(is_multisite()/* Multisite does NOT actually delete; ONLY removes. */)
									{
										remove_user_from_blog($user_id, $current_blog->blog_id);
										// This will automatically trigger `eot_del_notification_urls`.
										c_ws_plugin__s2member_user_deletions::handle_ms_user_deletions($user_id, $current_blog->blog_id, 's2says');
									}
									else // Otherwise, we can actually delete them.
										// This will automatically trigger `eot_del_notification_urls`
										wp_delete_user($user_id /* `c_ws_plugin__s2member_user_deletions::handle_user_deletions()` */);

									foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
									do_action('ws_plugin__s2member_during_auto_eot_system_during_delete', get_defined_vars());
									unset($__refs, $__v); // Housekeeping.
								}
								foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
								do_action('ws_plugin__s2member_during_auto_eot_system', get_defined_vars());
								unset($__refs, $__v); // Housekeeping.

								c_ws_plugin__s2member_utils_logs::log_entry('auto-eot-system', $log_entry);
							}
						}
					}
				}
			}
			c_ws_plugin__s2member_utils_logs::cleanup_expired_s2m_transients();

			foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
			do_action('ws_plugin__s2member_after_auto_eot_system', get_defined_vars());
			unset($__refs, $__v); // Housekeeping.
		}
	}
}

```