# s2member/trunk/src/includes/classes/tracking-codes.inc.php

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

- Page: https://pluginprobe.com/plugins/s2member/trunk/code/src/includes/classes/tracking-codes.inc.php
- Raw: https://pluginprobe.com/plugins/s2member/trunk/raw/src/includes/classes/tracking-codes.inc.php
- Modified: 2016-11-29T22:22:10+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/trunk/code/src/includes/classes/tracking-codes.inc.php#L10-L20`.

```php
<?php
// @codingStandardsIgnoreFile
/**
 * Tracking Codes.
 *
 * 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\Tracking
 * @since 3.5
 */
if(!defined('WPINC')) // MUST have WordPress.
	exit("Do not access this file directly.");

if(!class_exists("c_ws_plugin__s2member_tracking_codes"))
{
	/**
	 * Tracking Codes.
	 *
	 * @package s2Member\Tracking
	 * @since 3.5
	 */
	class c_ws_plugin__s2member_tracking_codes
	{
		/**
		 * Displays Signup Tracking Codes.
		 *
		 * These are stored inside s2Member's Transient Queue by the IPN processor.
		 *
		 * Tracking Codes are only displayed/processed one time.
		 * s2Member will display Tracking Codes in (1) of these 4 locations:
		 *
		 * o On the Return URL / Thank-You Page, after returning from your Payment Gateway.
		 * o Otherwise, on the Registration Form, after returning from your Payment Gateway.
		 * o Otherwise, if possible, on the Login Form *(in the footer)* after Registration is completed.
		 * o Otherwise, in the footer of your WordPress theme, as soon as possible; or after the Customer's very first login.
		 *
		 * @package s2Member\Tracking
		 * @since 3.5
		 *
		 * @attaches-to ``add_action("login_footer");``
		 * @attaches-to ``add_action("wp_footer");``
		 * @also-called-by {@link s2Member\Tracking\c_ws_plugin__s2member_tracking_codes::generate_all_tracking_codes()}
		 */
		public static function display_signup_tracking_codes()
		{
			do_action("ws_plugin__s2member_before_display_signup_tracking_codes", get_defined_vars());

			if((!empty($_COOKIE["s2member_tracking"]) && ($subscr_or_txn_id = c_ws_plugin__s2member_utils_encryption::decrypt($_COOKIE["s2member_tracking"]))) || (($reg_cookies = c_ws_plugin__s2member_register_access::reg_cookies_ok()) && extract($reg_cookies) && ($subscr_or_txn_id = $subscr_id)))
			{
				if(($code = get_transient($transient = "s2m_".md5("s2member_transient_signup_tracking_codes_".$subscr_or_txn_id))))
				{
					delete_transient($transient); // Only display this ONE time. Delete transient immediately.

					echo '<img src="'.esc_attr(home_url("/?s2member_delete_tracking_cookie=1")).'" alt="." style="width:1px; height:1px; border:0;" />'."\n";

					foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
					do_action("ws_plugin__s2member_during_display_signup_tracking_codes", get_defined_vars());
					unset($__refs, $__v);

					if(is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site())
						echo do_shortcode($code)."\n"; // No PHP here.

					else // Otherwise, safe to allow PHP code.
						echo do_shortcode(c_ws_plugin__s2member_utilities::evl($code));
				}
			}
			do_action("ws_plugin__s2member_after_display_signup_tracking_codes", get_defined_vars());
		}

		/**
		 * Displays Modification Tracking Codes.
		 *
		 * These are stored inside s2Member's Transient Queue by the IPN processor.
		 *
		 * Tracking Codes are only displayed/processed one time.
		 * s2Member will display Tracking Codes in (1) of these 3 locations:
		 *
		 * o On the Return URL / Thank-You Page, after returning from your Payment Gateway.
		 * o Otherwise, if possible, on the Login Form *(in the footer)* after returning from your Payment Gateway.
		 * o Otherwise, in the footer of your WordPress theme, as soon as possible; or after the Customer's next login.
		 *
		 * @package s2Member\Tracking
		 * @since 110815
		 *
		 * @attaches-to ``add_action("login_footer");``
		 * @attaches-to ``add_action("wp_footer");``
		 * @also-called-by {@link s2Member\Tracking\c_ws_plugin__s2member_tracking_codes::generate_all_tracking_codes()}
		 */
		public static function display_modification_tracking_codes()
		{
			do_action("ws_plugin__s2member_before_display_modification_tracking_codes", get_defined_vars());

			if((!empty($_COOKIE["s2member_tracking"]) && ($subscr_or_txn_id = c_ws_plugin__s2member_utils_encryption::decrypt($_COOKIE["s2member_tracking"]))) || (($reg_cookies = c_ws_plugin__s2member_register_access::reg_cookies_ok()) && extract($reg_cookies) && ($subscr_or_txn_id = $subscr_id)))
			{
				if(($code = get_transient($transient = "s2m_".md5("s2member_transient_modification_tracking_codes_".$subscr_or_txn_id))))
				{
					delete_transient($transient); // Only display this ONE time. Delete transient immediately.

					echo '<img src="'.esc_attr(home_url("/?s2member_delete_tracking_cookie=1")).'" alt="." style="width:1px; height:1px; border:0;" />'."\n";

					foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
					do_action("ws_plugin__s2member_during_display_modification_tracking_codes", get_defined_vars());
					unset($__refs, $__v);

					if(is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site())
						echo do_shortcode($code)."\n"; // No PHP here.

					else // Otherwise, safe to allow PHP code.
						echo do_shortcode(c_ws_plugin__s2member_utilities::evl($code));
				}
			}
			do_action("ws_plugin__s2member_after_display_modification_tracking_codes", get_defined_vars());
		}

		/**
		 * Displays Capability Tracking Codes.
		 *
		 * These are stored inside s2Member's Transient Queue by the IPN processor.
		 *
		 * Tracking Codes are only displayed/processed one time.
		 * s2Member will display Tracking Codes in (1) of these 3 locations:
		 *
		 * o On the Return URL / Thank-You Page, after returning from your Payment Gateway.
		 * o Otherwise, if possible, on the Login Form *(in the footer)* after returning from your Payment Gateway.
		 * o Otherwise, in the footer of your WordPress theme, as soon as possible; or after the Customer's next login.
		 *
		 * @package s2Member\Tracking
		 * @since 110815
		 *
		 * @attaches-to ``add_action("login_footer");``
		 * @attaches-to ``add_action("wp_footer");``
		 * @also-called-by {@link s2Member\Tracking\c_ws_plugin__s2member_tracking_codes::generate_all_tracking_codes()}
		 */
		public static function display_ccap_tracking_codes()
		{
			do_action("ws_plugin__s2member_before_display_ccap_tracking_codes", get_defined_vars());

			if((!empty($_COOKIE["s2member_tracking"]) && ($subscr_or_txn_id = c_ws_plugin__s2member_utils_encryption::decrypt($_COOKIE["s2member_tracking"]))) || (($reg_cookies = c_ws_plugin__s2member_register_access::reg_cookies_ok()) && extract($reg_cookies) && ($subscr_or_txn_id = $subscr_id)))
			{
				if(($code = get_transient($transient = "s2m_".md5("s2member_transient_ccap_tracking_codes_".$subscr_or_txn_id))))
				{
					delete_transient($transient); // Only display this ONE time. Delete transient immediately.

					echo '<img src="'.esc_attr(home_url("/?s2member_delete_tracking_cookie=1")).'" alt="." style="width:1px; height:1px; border:0;" />'."\n";

					foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
					do_action("ws_plugin__s2member_during_display_ccap_tracking_codes", get_defined_vars());
					unset($__refs, $__v);

					if(is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site())
						echo do_shortcode($code)."\n"; // No PHP here.

					else // Otherwise, safe to allow PHP code.
						echo do_shortcode(c_ws_plugin__s2member_utilities::evl($code));
				}
			}
			do_action("ws_plugin__s2member_after_display_ccap_tracking_codes", get_defined_vars());
		}

		/**
		 * Displays Specific Post/Page Tracking Codes.
		 *
		 * These are stored inside s2Member's Transient Queue, by BOTH the IPN & Return-Data processors.
		 *
		 * Specific Post/Page Tracking Codes are only displayed/processed one time.
		 * s2Member will display Tracking Codes in the footer of your theme.
		 *
		 * @package s2Member\Tracking
		 * @since 3.5
		 *
		 * @attaches-to ``add_action("login_footer");``
		 * @attaches-to ``add_action("wp_footer");``
		 * @also-called-by {@link s2Member\Tracking\c_ws_plugin__s2member_tracking_codes::generate_all_tracking_codes()}
		 *
		 * @return null After displaying possible Tracking Code(s).
		 */
		public static function display_sp_tracking_codes()
		{
			do_action("ws_plugin__s2member_before_display_sp_tracking_codes", get_defined_vars());

			if(!empty($_COOKIE["s2member_sp_tracking"]) && ($txn_id = c_ws_plugin__s2member_utils_encryption::decrypt($_COOKIE["s2member_sp_tracking"])))
			{
				if(($code = get_transient($transient = "s2m_".md5("s2member_transient_sp_tracking_codes_".$txn_id))))
				{
					delete_transient($transient); // Only display this ONE time. Delete transient immediately.

					echo '<img src="'.esc_attr(home_url("/?s2member_delete_sp_tracking_cookie=1")).'" alt="." style="width:1px; height:1px; border:0;" />'."\n";

					foreach(array_keys(get_defined_vars()) as $__v) $__refs[$__v] =& $$__v;
					do_action("ws_plugin__s2member_during_display_sp_tracking_codes", get_defined_vars());
					unset($__refs, $__v);

					if(is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site())
						echo $code."\n"; // No PHP here.

					else // Otherwise, it's safe to allow PHP code.
						eval("?>".$code);
				}
			}
			do_action("ws_plugin__s2member_after_display_sp_tracking_codes", get_defined_vars());
		}

		/**
		 * Generates/returns all Tracking Codes integrated with s2Member.
		 *
		 * This method may be used in areas where s2Member needs to build tracking codes in a more dynamic way.
		 *
		 * @package s2Member\Tracking
		 * @since 110720
		 *
		 * @return string HTML output for all Tracking Codes integrated with s2Member.
		 */
		public static function generate_all_tracking_codes()
		{
			ob_start(); // Begin output buffering so we can "return".

			c_ws_plugin__s2member_tracking_codes::display_signup_tracking_codes();
			c_ws_plugin__s2member_tracking_codes::display_modification_tracking_codes();
			c_ws_plugin__s2member_tracking_codes::display_ccap_tracking_codes();
			c_ws_plugin__s2member_tracking_codes::display_sp_tracking_codes();

			return apply_filters("ws_plugin__s2member_generate_all_tracking_codes", ob_get_clean(), get_defined_vars());
		}
	}
}

```