Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Auto_EOT_System

s2member\includes\classes\auto-eots.inc.php at line #28

Class c_ws_plugin__s2member_auto_eots

c_ws_plugin__s2member_auto_eots

public class c_ws_plugin__s2member_auto_eots

s2Member's Auto-EOT System (EOT = End Of Term).

Since:

3.5


( 3 Methods )
Method Summary
public static bool

add_auto_eot_system()

Adds a scheduled task for s2Member's Auto-EOT System.

public static null

auto_eot_system(int $per_process)

Processed by WP_Cron; this handles Auto-EOTs (EOT = End Of Term).

public static bool

delete_auto_eot_system()

Deletes all scheduled tasks for s2Member's Auto-EOT System.

( 3 Methods )
Method Detail

s2member\includes\classes\auto-eots.inc.php at line #38

add_auto_eot_system()

public static bool add_auto_eot_system()

Adds a scheduled task for s2Member's Auto-EOT System.

Since:

3.5

Returns:

bool - True if able to add Auto-EOT System schedule, else false.

[ back to top ]

s2member\includes\classes\auto-eots.inc.php at line #98

auto_eot_system()

public static null auto_eot_system(int $per_process)

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.

Since:

3.5

Parameters:

int $per_process - Number of database records to process each time. Can also be Filtered with ws_plugin__s2member_auto_eot_system_per_process.

Returns:

null

[ back to top ]

s2member\includes\classes\auto-eots.inc.php at line #65

delete_auto_eot_system()

public static bool delete_auto_eot_system()

Deletes all scheduled tasks for s2Member's Auto-EOT System.

Since:

3.5

Returns:

bool - True if able to delete Auto-EOT System schedule, else false.

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail