Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\No_Cache

s2member\includes\classes\no-cache.inc.php at line #28

Class c_ws_plugin__s2member_no_cache

c_ws_plugin__s2member_no_cache

public class c_ws_plugin__s2member_no_cache

No-cache routines.

Since:

3.5


( 1 Field )
Field Summary
public static null|bool

$headers

No-cache headers required?

( 3 Methods )
Method Summary
public static bool

no_cache(bool $no_cache)

Handles no-cache constants, and no-cache headers.

public static bool

no_cache_constants(bool $no_cache)

Defines no-cache constants for various WordPress® plugins.

public static bool

no_cache_headers(bool $no_cache)

Sends Cache-Control (no-cache) headers.

( 1 Field )
Field Detail

s2member\includes\classes\no-cache.inc.php at line #38

headers

public static null|bool $headers = FALSE

No-cache headers required?

Since:

111115

[ back to top ]

( 3 Methods )
Method Detail

s2member\includes\classes\no-cache.inc.php at line #51

no_cache()

public static bool no_cache(bool $no_cache)

Handles no-cache constants, and no-cache headers.

Since:

3.5

Attaches-to:

add_action("init");

Also-called-by:

Other routines within s2Member.

Parameters:

bool $no_cache - Optional. Defaults to false. If true, force no-cache if at all possible.

Returns:

bool - This function will always return true.

[ back to top ]

s2member\includes\classes\no-cache.inc.php at line #83

no_cache_constants()

public static bool no_cache_constants(bool $no_cache)

Defines no-cache constants for various WordPress® plugins.

This is compatible with Quick Cache, W3 Total Cache, and also with WP Super Cache. Quick Cache uses: QUICK_CACHE_ALLOWED, and other plugins use: DONOTCACHEPAGE. W3 Total Cache is also known to be compatible with DONOTCACHEOBJECT and DONOTCACHEDB.

Disallow caching if the $no_cache parameter is passed in as true, by other routines. In addition, always disallow caching for logged in users, and GET requests with: /?s2member Systematics. For clarity on s2Member Systematics, see: s2Member\Systematicsc_ws_plugin__s2member_systematics::is_s2_systematic_use_page().

However, this routine will ALWAYS obey the ?qcAC query string parameter. This Quick Cache parameter explicitly allows caching to occur.

Since:

3.5

Also-called-by:

Other routines within s2Member.

Parameters:

bool $no_cache - Optional. Defaults to false. If true, force no-cache if at all possible.

Returns:

bool - This function will always return true.

[ back to top ]

s2member\includes\classes\no-cache.inc.php at line #163

no_cache_headers()

public static bool no_cache_headers(bool $no_cache)

Sends Cache-Control (no-cache) headers.

Disallow browser caching if the $no_cache parameter is passed in as true, by other routines. Disallow browser caching when/if no-cache Constants are set by s2Member\No_Cachec_ws_plugin__s2member_no_cache::no_cache_constants(), via static variable boolean value for: c_ws_plugin__s2member_no_cache::$headers.

However, this routine will ALWAYS obey the ?qcABC query string parameter. This Quick Cache parameter explicitly allows browser caching to occur.

Since:

3.5

Also-called-by:

Other routines within s2Member.

Parameters:

bool $no_cache - Optional. Defaults to false. If true, force no-cache if at all possible.

Returns:

bool - This function will always return true.

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail