user_info = $user_info;
$this->last_event = '';
}
public static function initialize() {
if ( ! is_admin() ) {
return;
}
// Initialize PixelID in storage - this will only need to happen when the
// user is an admin
$pixel_id = self::get_pixel_id();
if ( ! WC_Facebookcommerce_Utils::is_valid_id( $pixel_id ) &&
class_exists( 'WC_Facebookcommerce_WarmConfig' ) ) {
$fb_warm_pixel_id = WC_Facebookcommerce_WarmConfig::$fb_warm_pixel_id;
if ( WC_Facebookcommerce_Utils::is_valid_id( $fb_warm_pixel_id ) &&
(int) $fb_warm_pixel_id == $fb_warm_pixel_id ) {
$fb_warm_pixel_id = (string) $fb_warm_pixel_id;
self::set_pixel_id( $fb_warm_pixel_id );
}
}
$is_advanced_matching_enabled = self::get_use_pii_key();
if ( $is_advanced_matching_enabled == null &&
class_exists( 'WC_Facebookcommerce_WarmConfig' ) ) {
$fb_warm_is_advanced_matching_enabled =
WC_Facebookcommerce_WarmConfig::$fb_warm_is_advanced_matching_enabled;
if ( is_bool( $fb_warm_is_advanced_matching_enabled ) ) {
self::set_use_pii_key( $fb_warm_is_advanced_matching_enabled ? 1 : 0 );
}
}
}
/**
* Gets Facebook Pixel init code.
*
* Init code might contain additional information to help matching website users with facebook users.
* Information is hashed in JS side using SHA256 before sending to Facebook.
*
* @return string
*/
private function get_pixel_init_code() {
$agent_string = Event::get_platform_identifier();
/**
* Filters Facebook Pixel init code.
*
* @param string $js_code
*/
return apply_filters( 'facebook_woocommerce_pixel_init', sprintf(
"fbq('init', '%s', %s, %s);\n",
esc_js( self::get_pixel_id() ),
json_encode( $this->user_info, JSON_PRETTY_PRINT | JSON_FORCE_OBJECT ),
json_encode( [ 'agent' => $agent_string ], JSON_PRETTY_PRINT | JSON_FORCE_OBJECT )
) );
}
/**
* Gets the Facebook Pixel code scripts.
*
* @return string HTML scripts
*/
public function pixel_base_code() {
$pixel_id = self::get_pixel_id();
// bail if no ID or already rendered
if ( empty( $pixel_id )|| ! empty( self::$render_cache[ self::PIXEL_RENDER ] ) ) {
return '';
}
self::$render_cache[ self::PIXEL_RENDER ] = true;
ob_start();
?>
; ?>&ev=PageView&noscript=1)
last_event;
}
/**
* Determines if the last event in the current thread matches a given event.
*
* TODO remove this deprecated method by March 2020 or version 2.0.0 {FN 2020-03-25}
*
* @deprecated since 1.11.0
*
* @param string $event_name
* @return bool
*/
public function check_last_event( $event_name ) {
wc_deprecated_function( __METHOD__, '1.11.0', __CLASS__ . '::has_last_event()' );
return $this->is_last_event( $event_name );
}
/**
* Gets the JavaScript code to track an event.
*
* Updates the last event property and returns the code.
*
* Use {@see \WC_Facebookcommerce_Pixel::inject_event()} to print or enqueue the code.
*
* @since 1.10.2
*
* @param string $event_name the name of the event to track
* @param array $params custom event parameters
* @param string $method name of the pixel's fbq() function to call
* @return string
*/
public function get_event_code( $event_name, $params, $method = 'track' ) {
$this->last_event = $event_name;
return self::build_event( $event_name, $params, $method );
}
/**
* Gets the JavaScript code to track an event wrapped in
get_event_code( $event_name, self::build_params( $params, $event_name ), $method ) );
} else {
// phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
printf( $this->get_event_script( $event_name, self::build_params( $params, $event_name ), $method ) );
}
}
/**
* Gets the JavaScript code to track a conditional event wrapped in
get_conditional_event_script( $event_name, self::build_params( $params, $event_name ), $listener, $jsonified_pii );
}
/**
* Gets the JavaScript code to track a conditional event that is only triggered one time wrapped in
$event_id ], JSON_PRETTY_PRINT | JSON_FORCE_OBJECT )
);
} else {
$event = sprintf(
"/* %s Facebook Integration Event Tracking */\n" .
"fbq('set', 'agent', '%s', '%s');\n".
"fbq('%s', '%s', %s);",
WC_Facebookcommerce_Utils::getIntegrationName(),
Event::get_platform_identifier(),
self::get_pixel_id(),
esc_js( $method ),
esc_js( $event_name ),
json_encode( self::build_params( $params, $event_name ), JSON_PRETTY_PRINT | JSON_FORCE_OBJECT )
);
}
return $event;
}
/**
* Gets an array with version_info for pixel fires.
*
* Parameters provided by users should not be overwritten by this function.
*
* @since 1.10.2
*
* @param array $params user defined parameters
* @param string $event the event name the params are for
* @return array
*/
private static function build_params( $params = [], $event = '' ) {
$params = array_replace( Event::get_version_info(), $params );
/**
* Filters the parameters for the pixel code.
*
* @since 1.10.2
*
* @param array $params user defined parameters
* @param string $event the event name
*/
return (array) apply_filters( 'wc_facebook_pixel_params', $params, $event );
}
/**
* Gets script tag attributes.
*
* @since 1.10.2
*
* @return string
*/
private static function get_script_attributes() {
$script_attributes = '';
/**
* Filters Facebook Pixel script attributes.
*
* @since 1.10.2
*
* @param array $custom_attributes
*/
$custom_attributes = (array) apply_filters( 'wc_facebook_pixel_script_attributes', [ 'type' => 'text/javascript' ] );
foreach ( $custom_attributes as $tag => $value ) {
$script_attributes .= ' ' . $tag . '="' . esc_attr( $value ) . '"';
}
return $script_attributes;
}
public static function get_pixel_id() {
$fb_options = self::get_options();
if ( ! $fb_options ) {
return '';
}
return isset( $fb_options[ self::PIXEL_ID_KEY ] ) ?
$fb_options[ self::PIXEL_ID_KEY ] : '';
}
public static function set_pixel_id( $pixel_id ) {
$fb_options = self::get_options();
if ( isset( $fb_options[ self::PIXEL_ID_KEY ] )
&& $fb_options[ self::PIXEL_ID_KEY ] == $pixel_id ) {
return;
}
$fb_options[ self::PIXEL_ID_KEY ] = $pixel_id;
update_option( self::SETTINGS_KEY, $fb_options );
}
public static function get_use_pii_key() {
$fb_options = self::get_options();
if ( ! $fb_options ) {
return null;
}
return isset( $fb_options[ self::USE_PII_KEY ] ) ?
$fb_options[ self::USE_PII_KEY ] : null;
}
public static function set_use_pii_key( $use_pii ) {
$fb_options = self::get_options();
if ( isset( $fb_options[ self::USE_PII_KEY ] )
&& $fb_options[ self::USE_PII_KEY ] == $use_pii ) {
return;
}
$fb_options[ self::USE_PII_KEY ] = $use_pii;
update_option( self::SETTINGS_KEY, $fb_options );
}
public static function get_use_s2s() {
$fb_options = self::get_options();
if ( ! $fb_options ) {
return false;
}
return isset( $fb_options[ self::USE_S2S_KEY ] ) ?
$fb_options[ self::USE_S2S_KEY ] : false;
}
public static function set_use_s2s( $use_s2s ) {
$fb_options = self::get_options();
if ( isset( $fb_options[ self::USE_S2S_KEY ] )
&& $fb_options[ self::USE_S2S_KEY ] == $use_s2s ) {
return;
}
$fb_options[ self::USE_S2S_KEY ] = $use_s2s;
update_option( self::SETTINGS_KEY, $fb_options );
}
public static function get_access_token() {
$fb_options = self::get_options();
if ( ! $fb_options ) {
return '';
}
return isset( $fb_options[ self::ACCESS_TOKEN_KEY ] ) ?
$fb_options[ self::ACCESS_TOKEN_KEY ] : '';
}
public static function set_access_token( $access_token ) {
$fb_options = self::get_options();
if ( isset( $fb_options[ self::ACCESS_TOKEN_KEY ] )
&& $fb_options[ self::ACCESS_TOKEN_KEY ] == $access_token ) {
return;
}
$fb_options[ self::ACCESS_TOKEN_KEY ] = $access_token;
update_option( self::SETTINGS_KEY, $fb_options );
}
private static function get_version_info() {
global $wp_version;
if ( WC_Facebookcommerce_Utils::isWoocommerceIntegration() ) {
return array(
'source' => 'woocommerce',
'version' => WC()->version,
'pluginVersion' => WC_Facebookcommerce_Utils::PLUGIN_VERSION,
);
}
return array(
'source' => 'wordpress',
'version' => $wp_version,
'pluginVersion' => WC_Facebookcommerce_Utils::PLUGIN_VERSION,
);
}
public static function get_options() {
return get_option(
self::SETTINGS_KEY,
array(
self::PIXEL_ID_KEY => '0',
self::USE_PII_KEY => 0,
self::USE_S2S_KEY => false,
self::ACCESS_TOKEN_KEY => '',
)
);
}
/**
* Gets Facebook Pixel base code.
*
* @deprecated since 1.10.2
*
* @return string
*/
public static function get_basecode() {
wc_deprecated_function( __METHOD__, '1.10.2' );
return '';
}
/**
* Gets the logged in user info
*
* @return string[]
*/
public function get_user_info(){
return $this->user_info;
}
}
endif;