├── .gitignore
├── templates
├── alias.php
├── settings.php
├── identify.php
├── track.php
├── page.php
└── snippet.php
├── uninstall.php
├── Makefile
├── .travis.yml
├── includes
├── class.analytics.php
├── class.analytics-wordpress.php
├── class.segment-cookie.php
└── class.segment-settings.php
├── tests
├── bootstrap.php
├── test-segment-analytics.php
├── test-segment-settings.php
└── test-segment-analytics-wordpress.php
├── integrations
├── intercom.php
├── ecommerce.php
└── ecommerce
│ ├── wp-e-commerce.php
│ └── woocommerce.php
├── phpunit.xml
├── bin
├── install-wp-tests.sh
└── deploy
├── readme.md
├── license.txt
└── analytics-wordpress.php
/.gitignore:
--------------------------------------------------------------------------------
1 | test
--------------------------------------------------------------------------------
/templates/alias.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/uninstall.php:
--------------------------------------------------------------------------------
1 |
2 |
3 |
10 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 |
3 | php:
4 | - 5.3
5 | - 5.4
6 |
7 | env:
8 | - WP_VERSION=latest WP_MULTISITE=0
9 | - WP_VERSION=latest WP_MULTISITE=1
10 | - WP_VERSION=3.8 WP_MULTISITE=0
11 | - WP_VERSION=3.8 WP_MULTISITE=1
12 |
13 | before_script:
14 | - bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
15 |
16 | script: phpunit
17 |
--------------------------------------------------------------------------------
/templates/identify.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/includes/class.analytics.php:
--------------------------------------------------------------------------------
1 |
2 | analytics.track();
3 |
6 |
7 | analytics.ajaxurl = "";
8 |
9 | jQuery( document ).ready( function( $ ) {
10 | var data = {
11 | action : 'segment_unset_cookie',
12 | key : '',
13 |
14 | },
15 | success = function( response ) {
16 | console.log( response );
17 | };
18 |
19 | $.post( analytics.ajaxurl, data, success );
20 | });
21 |
22 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/templates/page.php:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/integrations/intercom.php:
--------------------------------------------------------------------------------
1 | hash_hmac( 'sha256', $user_email, $settings['use_intercom_secure_mode'] )
22 | );
23 | }
24 |
25 | return $identify;
26 | }
27 |
28 | add_filter( 'segment_get_current_user_identify', 'segment_intercom_integration', 10, 2 );
--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
1 |
2 |
18 |
19 |
20 | ./tests
21 |
22 |
23 |
24 |
25 | ./tmp/
26 | ./tests/
27 | ./templates/
28 | ./languages/
29 | ./integrations/
30 |
31 |
32 |
--------------------------------------------------------------------------------
/tests/test-segment-analytics.php:
--------------------------------------------------------------------------------
1 | object = Segment_Analytics::get_instance();
9 | }
10 |
11 | public function tearDown() {
12 | parent::tearDown();
13 | }
14 |
15 | public function test_segment_instance() {
16 | $this->assertClassHasStaticAttribute( 'instance', 'Segment_Analytics' );
17 | }
18 |
19 | /**
20 | * @covers Segment_Analytics::setup_constants
21 | */
22 | public function test_constants() {
23 |
24 | // Plugin File Path
25 | $path = str_replace( "/tests", '', dirname( __FILE__ ) );
26 | $this->assertSame( SEG_FILE_PATH, $path );
27 |
28 | // Plugin Folder
29 | $path = str_replace( "/tests", '', dirname( plugin_basename( __FILE__ ) ) );
30 | $this->assertSame( SEG_FOLDER, $path );
31 |
32 | // Plugin Root File
33 | $path = str_replace( "/tests", '', plugins_url( '', __FILE__ ) );
34 | $this->assertSame( SEG_URL, $path );
35 |
36 | }
37 |
38 | }
39 |
40 |
--------------------------------------------------------------------------------
/templates/snippet.php:
--------------------------------------------------------------------------------
1 |
9 |
--------------------------------------------------------------------------------
/bin/install-wp-tests.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | if [ $# -lt 3 ]; then
4 | echo "usage: $0 [db-host] [wp-version]"
5 | exit 1
6 | fi
7 |
8 | DB_NAME=$1
9 | DB_USER=$2
10 | DB_PASS=$3
11 | DB_HOST=${4-localhost}
12 | WP_VERSION=${5-latest}
13 |
14 | WP_TESTS_DIR=${WP_TESTS_DIR-/tmp/wordpress-tests-lib}
15 | WP_CORE_DIR=/tmp/wordpress/
16 |
17 | set -ex
18 |
19 | install_wp() {
20 | mkdir -p $WP_CORE_DIR
21 |
22 | if [ $WP_VERSION == 'latest' ]; then
23 | local ARCHIVE_NAME='latest'
24 | else
25 | local ARCHIVE_NAME="wordpress-$WP_VERSION"
26 | fi
27 |
28 | wget -nv -O /tmp/wordpress.tar.gz http://wordpress.org/${ARCHIVE_NAME}.tar.gz
29 | tar --strip-components=1 -zxmf /tmp/wordpress.tar.gz -C $WP_CORE_DIR
30 |
31 | wget -nv -O $WP_CORE_DIR/wp-content/db.php https://raw.github.com/markoheijnen/wp-mysqli/master/db.php
32 | }
33 |
34 | install_test_suite() {
35 | # portable in-place argument for both GNU sed and Mac OSX sed
36 | if [[ $(uname -s) == 'Darwin' ]]; then
37 | local ioption='-i .bak'
38 | else
39 | local ioption='-i'
40 | fi
41 |
42 | # set up testing suite
43 | mkdir -p $WP_TESTS_DIR
44 | cd $WP_TESTS_DIR
45 | svn co --quiet http://develop.svn.wordpress.org/trunk/tests/phpunit/includes/
46 |
47 | wget -nv -O wp-tests-config.php http://develop.svn.wordpress.org/trunk/wp-tests-config-sample.php
48 | sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR':" wp-tests-config.php
49 | sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" wp-tests-config.php
50 | sed $ioption "s/yourusernamehere/$DB_USER/" wp-tests-config.php
51 | sed $ioption "s/yourpasswordhere/$DB_PASS/" wp-tests-config.php
52 | sed $ioption "s|localhost|${DB_HOST}|" wp-tests-config.php
53 | }
54 |
55 | install_db() {
56 | # parse DB_HOST for port or socket references
57 | local PARTS=(${DB_HOST//\:/ })
58 | local DB_HOSTNAME=${PARTS[0]};
59 | local DB_SOCK_OR_PORT=${PARTS[1]};
60 | local EXTRA=""
61 |
62 | if ! [ -z $DB_HOSTNAME ] ; then
63 | if [[ "$DB_SOCK_OR_PORT" =~ ^[0-9]+$ ]] ; then
64 | EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
65 | elif ! [ -z $DB_SOCK_OR_PORT ] ; then
66 | EXTRA=" --socket=$DB_SOCK_OR_PORT"
67 | elif ! [ -z $DB_HOSTNAME ] ; then
68 | EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
69 | fi
70 | fi
71 |
72 | # create database
73 | mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
74 | }
75 |
76 | install_wp
77 | install_test_suite
78 | install_db
79 |
--------------------------------------------------------------------------------
/bin/deploy:
--------------------------------------------------------------------------------
1 | #! /bin/bash
2 | #
3 | # Script to deploy from Github to WordPress.org Plugin Repository
4 | # A modification of Dean Clatworthy's deploy script as found here: https://github.com/deanc/wordpress-plugin-git-svn
5 | # The difference is that this script lives in the plugin's git repo & doesn't require an existing SVN repo.
6 | # Source: https://github.com/thenbrent/multisite-user-management/blob/master/deploy.sh
7 |
8 | # plugin slug
9 | PLUGINSLUG="analytics-wordpress"
10 |
11 | # main config, set off of plugin slug
12 | CURRENTDIR=`pwd`
13 | MAINFILE="$PLUGINSLUG.php" # this should be the name of your main php file in the wordpress plugin
14 |
15 | # git config
16 | GITPATH="$CURRENTDIR" # this file should be in the base of your git repository
17 |
18 | # svn config
19 | SVNPATH="/tmp/$PLUGINSLUG" # path to a temp SVN repo. No trailing slash required and don't add trunk.
20 | SVNURL="http://plugins.svn.wordpress.org/segmentio/" # Remote SVN repo on WordPress.org, with no trailing slash
21 | SVNUSER="segmentio" # your svn username
22 |
23 | # Let's begin...
24 | echo ".........................................."
25 | echo
26 | echo "Preparing to deploy WordPress plugin"
27 | echo
28 | echo ".........................................."
29 | echo
30 |
31 | # Check version in readme.txt is the same as plugin file
32 | NEWVERSION1=`grep "^Stable tag" $GITPATH/readme.md | awk -F' ' '{print $3}'`
33 | echo "readme version: $NEWVERSION1"
34 | NEWVERSION2=`grep "^Version" $GITPATH/$MAINFILE | awk -F' ' '{print $2}'`
35 | echo "$MAINFILE version: $NEWVERSION2"
36 |
37 | if [ "$NEWVERSION1" != "$NEWVERSION2" ]; then echo "Versions don't match. Fix that! ...."; exit 1; fi
38 |
39 | echo "Versions match in readme.txt and PHP file. Let's proceed..."
40 |
41 | cd $GITPATH
42 | git commit -am "$NEWVERSION1"
43 |
44 | echo "Tagging new version in git"
45 | git tag -a "$NEWVERSION1" -m "Tagging version $NEWVERSION1"
46 |
47 | echo "Pushing latest commit to origin, with tags"
48 | git push origin master
49 | git push origin master --tags
50 |
51 | echo
52 | echo "Creating local copy of SVN repo ..."
53 | svn co $SVNURL $SVNPATH
54 |
55 | echo "Ignoring github specific files and deployment script"
56 | svn propset svn:ignore "
57 | Readme.md
58 | .git
59 | .gitignore" "$SVNPATH/trunk/"
60 |
61 | #export git -> SVN
62 | echo "Exporting the HEAD of master from git to the trunk of SVN"
63 | git checkout-index -a -f --prefix=$SVNPATH/trunk/
64 |
65 |
66 | echo "Changing directory to SVN and committing to trunk"
67 | cd $SVNPATH/trunk/
68 | # Add all new files that are not set to be ignored
69 | svn status | grep -v "^.[ \t]*\..*" | grep "^?" | awk '{print $2}' | xargs svn add
70 | svn commit --username=$SVNUSER -m "$NEWVERSION1"
71 |
72 | echo "Creating new SVN tag & committing it"
73 | cd $SVNPATH
74 | svn copy trunk/ tags/$NEWVERSION1/
75 | cd $SVNPATH/tags/$NEWVERSION1
76 | svn commit --username=$SVNUSER -m "Tagging version $NEWVERSION1"
77 |
78 | echo "Removing temporary directory $SVNPATH"
79 | rm -fr $SVNPATH/
80 |
81 | echo "*** FIN ***"
82 |
--------------------------------------------------------------------------------
/includes/class.segment-cookie.php:
--------------------------------------------------------------------------------
1 | 'on',
17 | 'track_pages' => 'on',
18 | 'track_archives' => 'on',
19 | 'track_comments' => 'on',
20 | 'track_logins' => 'on'
21 | );
22 |
23 | $expected = array(
24 | 'track_posts' => '1',
25 | 'track_pages' => '1',
26 | 'track_archives' => '1',
27 | 'track_comments' => '1',
28 | 'track_logins' => '1',
29 | 'track_login_page' => '0',
30 | 'track_searches' => '0',
31 | );
32 |
33 | $output = Segment_Settings::core_validation( $input );
34 |
35 | foreach ( $output as $name => $value ) {
36 | if ( isset( $expected[ $name ] ) ) {
37 | $this->assertEquals(
38 | $expected[ $name ],
39 | $output[ $name ]
40 | );
41 | }
42 | }
43 |
44 | }
45 |
46 | public function test_core_validation_text_fields() {
47 |
48 | $input = array(
49 | 'api_key' => ' 9sdfks929203',
50 | 'use_intercom_secure_mode' => ' yetanotherapikey '
51 | );
52 |
53 | $expected = array(
54 | 'api_key' => '9sdfks929203',
55 | 'use_intercom_secure_mode' => 'yetanotherapikey'
56 | );
57 |
58 | $output = Segment_Settings::core_validation( $input );
59 |
60 | foreach ( $output as $name => $value ) {
61 | if ( isset( $expected[ $name ] ) ) {
62 | $this->assertEquals(
63 | $expected[ $name ],
64 | $output[ $name ]
65 | );
66 | }
67 | }
68 |
69 | }
70 |
71 | public function test_core_validation_integers() {
72 | $input = array(
73 | 'ignore_user_level' => '1'
74 | );
75 |
76 | $expected = array(
77 | 'ignore_user_level' => 1
78 | );
79 |
80 | $output = Segment_Settings::core_validation( $input );
81 |
82 | foreach ( $output as $name => $value ) {
83 | if ( isset( $expected[ $name ] ) ) {
84 | $this->assertEquals(
85 | $expected[ $name ],
86 | $output[ $name ]
87 | );
88 | }
89 | }
90 |
91 | }
92 |
93 | public function test_core_validation_filter() {
94 |
95 | add_filter( 'segment_settings_core_validation', function( $input ) {
96 |
97 | if ( isset( $input['custom_input_validation'] ) ) {
98 |
99 | /* Random validation routine: Append a string to input */
100 | $input['custom_input_validation'] .= " when you're part of a team.";
101 | }
102 |
103 | return $input;
104 | } );
105 |
106 | $input = array(
107 | 'custom_input_validation' => 'Everything is awesome! Everythng is cool'
108 | );
109 |
110 | $expected = array(
111 | 'custom_input_validation' => "Everything is awesome! Everythng is cool when you're part of a team."
112 | );
113 |
114 | $output = Segment_Settings::core_validation( $input );
115 |
116 | foreach ( $output as $name => $value ) {
117 | if ( isset( $expected[ $name ] ) ) {
118 | $this->assertEquals(
119 | $expected[ $name ],
120 | $output[ $name ]
121 | );
122 | }
123 | }
124 |
125 | }
126 |
127 | }
128 |
--------------------------------------------------------------------------------
/integrations/ecommerce.php:
--------------------------------------------------------------------------------
1 | registered_events = array(
32 | 'viewed_category',
33 | 'viewed_product',
34 | 'added_to_cart',
35 | 'removed_from_cart',
36 | 'completed_order',
37 | );
38 |
39 | return $this;
40 | }
41 |
42 | /**
43 | * Registers hooks for the Segment Commerce system.
44 | *
45 | * Usable by plugins to register methods or functions to hook into different eCommerce events.
46 | * Someday, late static binding will be available to all WordPress users, which will make this a bit less hacky.
47 | *
48 | * @since 1.0.0
49 | * @access public
50 | *
51 | * @param string $hook The WordPress action ( e.g. do_action( '' ) )
52 | * @param string $event The name of the function or method that handles the tracking output.
53 | * @param object $class The class, if any, that contains the $event method.
54 | *
55 | * @return mixed $registered False if no event was registered, string if function was registered, array if method.
56 | */
57 | public function register_hook( $hook, $event, $args = 1, $class = '' ) {
58 |
59 | $registered_events = $this->get_registered_hooks();
60 |
61 | if ( ! in_array( $event, $registered_events ) ) {
62 | return false;
63 | }
64 |
65 | if ( ! empty( $class ) && is_callable( array( $class, $event ) ) ) {
66 |
67 | $this->registered_events[ $hook ] = array( $class, $event );
68 |
69 | $registered = add_filter( $hook, array( $class, $event ), 10, $args );
70 |
71 | } else if ( is_callable( $event ) ) {
72 |
73 | $this->registered_events[ $hook ] = $event;
74 | $registered = add_filter( $hook, $event, 10, $args );
75 |
76 | } else {
77 |
78 | $registered = false;
79 |
80 | }
81 |
82 | return $registered;
83 | }
84 |
85 | /**
86 | * Returns the registered events.
87 | *
88 | * Sub-classes can filter this to add additional events to be triggered.
89 | *
90 | * @since 1.0.0
91 | * @access public
92 | *
93 | * @return array Filtered events.
94 | */
95 | public function get_registered_hooks() {
96 | return apply_filters( 'segment_commerce_events', array_filter( $this->registered_events ), $this );
97 | }
98 |
99 | /**
100 | * Basic bootstrap for core integrations.
101 | *
102 | * @since 1.0.0
103 | * @access public
104 | */
105 | public static function bootstrap() {
106 |
107 | if ( class_exists( 'WP_eCommerce' ) ) {
108 | include_once SEG_FILE_PATH . '/integrations/ecommerce/wp-e-commerce.php';
109 | } else if ( class_exists( 'WooCommerce' ) ) {
110 | include_once SEG_FILE_PATH . '/integrations/ecommerce/woocommerce.php';
111 | }
112 |
113 | }
114 |
115 | /**
116 | * Event to be fired when a product category is viewed.
117 | * Abstract method, must be overridden by sub-class.
118 | *
119 | * @since 1.0.0
120 | */
121 | abstract function viewed_category();
122 |
123 | /**
124 | * Event to be fired when a product is viewed.
125 | * Abstract method, must be overridden by sub-class.
126 | *
127 | * @since 1.0.0
128 | */
129 | abstract function viewed_product();
130 |
131 | /**
132 | * Event to be fired when a product is added to the cart.
133 | * Abstract method, must be overridden by sub-class.
134 | *
135 | * @since 1.0.0
136 | */
137 | abstract function added_to_cart();
138 |
139 | /**
140 | * Event to be fired when a product removed from the cart.
141 | * Abstract method, must be overridden by sub-class.
142 | *
143 | * @since 1.0.0
144 | */
145 | abstract function removed_from_cart();
146 |
147 | /**
148 | * Event to be fired when an order is successfully completed.
149 | * Abstract method, must be overridden by sub-class.
150 | *
151 | * @since 1.0.0
152 | */
153 | abstract function completed_order();
154 |
155 | }
156 |
157 | Segment_Commerce::bootstrap();
--------------------------------------------------------------------------------
/tests/test-segment-analytics-wordpress.php:
--------------------------------------------------------------------------------
1 | object = Segment_Analytics_WordPress::get_instance();
9 | }
10 |
11 | public function tearDown() {
12 | parent::tearDown();
13 | wp_set_current_user( 0 );
14 | }
15 |
16 | public function test_segment_instance() {
17 | $this->assertClassHasStaticAttribute( 'instance', 'Segment_Analytics_WordPress' );
18 | }
19 |
20 | public function test_includes() {
21 | $this->assertFileExists( SEG_FILE_PATH . '/includes/class.segment-settings.php' );
22 | $this->assertFileExists( SEG_FILE_PATH . '/includes/class.segment-cookie.php' );
23 | $this->assertFileExists( SEG_FILE_PATH . '/integrations/ecommerce.php' );
24 | $this->assertFileExists( SEG_FILE_PATH . '/integrations/intercom.php' );
25 | }
26 |
27 | public function test_admin_actions() {
28 |
29 | $this->assertEquals( has_action( 'admin_menu' , array( $this->object, 'admin_menu' ) ), 10 );
30 | $this->assertEquals( has_filter( 'plugin_action_links' , array( $this->object, 'plugin_action_links' ) ), 10 );
31 | $this->assertEquals( has_filter( 'plugin_row_meta' , array( $this->object, 'plugin_row_meta' ) ), 10 );
32 | $this->assertEquals( has_action( 'admin_init' , array( $this->object, 'register_settings' ) ), 10 );
33 | }
34 |
35 | public function test_frontend_hooks() {
36 |
37 | $this->assertEquals( has_filter( 'wp_head' , array( $this->object, 'wp_head' ) ) , 9 );
38 | $this->assertEquals( has_filter( 'admin_head' , array( $this->object, 'wp_head' ) ) , 9 );
39 | $this->assertEquals( has_filter( 'login_head' , array( $this->object, 'wp_head' ) ) , 9 );
40 | $this->assertEquals( has_filter( 'wp_footer' , array( $this->object, 'wp_footer' ) ), 9 );
41 | $this->assertEquals( has_filter( 'login_footer', array( $this->object, 'wp_footer' ) ), 9 );
42 | $this->assertEquals( has_filter( 'admin_footer', array( $this->object, 'wp_footer' ) ), 9 );
43 | $this->assertEquals( has_filter( 'wp_insert_comment', array( $this->object, 'insert_comment' ) ), 9 );
44 | $this->assertEquals( has_filter( 'wp_login' , array( $this->object, 'login_event' ) ) , 9 );
45 | $this->assertEquals( has_filter( 'user_register' , array( $this->object, 'user_register' ) ) , 9 );
46 | }
47 |
48 | public function test_ignore_user_level() {
49 |
50 | $ignore_user_level = array(
51 | '0' => 'subscriber',
52 | '1' => 'contributor',
53 | '2' => 'author',
54 | '5' => 'editor',
55 | '8' => 'administrator'
56 | );
57 |
58 | foreach ( $ignore_user_level as $level => $role ) {
59 |
60 | wp_set_current_user( $this->factory->user->create( array( 'role' => $role ) ) );
61 |
62 | $this->assertLessThanOrEqual( wp_get_current_user()->user_level, $level );
63 | }
64 | }
65 |
66 | public function test_register_settings_is_setting_registered() {
67 | global $new_allowlist_options;
68 |
69 | $this->object->register_settings();
70 |
71 | $plugin = $this->object;
72 | $slug = $plugin::SLUG;
73 |
74 | $this->assertArrayHasKey( $slug, $new_allowlist_options );
75 |
76 | $name = $new_allowlist_options[ $slug ];
77 |
78 | $this->assertContains( $this->object->get_option_name(), $name );
79 | }
80 |
81 | public function test_register_settings_default_settings_sections_and_fields_exist() {
82 | global $wp_settings_sections, $wp_settings_fields;
83 |
84 | $plugin = $this->object;
85 | $slug = $plugin::SLUG;
86 |
87 | $plugin->register_settings();
88 |
89 | $this->assertarrayHasKey( $slug, $wp_settings_sections );
90 | $this->assertarrayHasKey( $slug, $wp_settings_fields );
91 |
92 | $settings = $this->object->_get_default_settings();
93 |
94 | foreach ( $settings as $section_name => $section ) {
95 |
96 | $this->assertArrayHasKey( $section_name, $wp_settings_sections[ $slug ] );
97 | $this->assertTrue( is_array( $wp_settings_sections[ $slug ][ $section_name ] ) );
98 | $this->assertEquals( $wp_settings_sections[ $slug ][ $section_name ]['id'], $section_name );
99 | $this->assertEquals( $wp_settings_sections[ $slug ][ $section_name ]['title'], $section['title'] );
100 | $this->assertEquals( $wp_settings_sections[ $slug ][ $section_name ]['callback'], $section['callback'] );
101 |
102 | foreach ( $section['fields'] as $field ) {
103 |
104 | $this->assertArrayHasKey( $section_name, $wp_settings_fields[ $slug ] );
105 | $this->assertTrue( is_array( $wp_settings_fields[ $slug ][ $section_name ] ) );
106 |
107 | $this->assertArrayHasKey( $field['name'], $wp_settings_fields[ $slug ][ $section_name ] );
108 | $this->assertTrue( is_array( $wp_settings_fields[ $slug ][ $section_name ][ $field['name'] ] ) );
109 |
110 | $this->assertEquals( $wp_settings_fields[ $slug ][ $section_name ][ $field['name'] ]['id'], $field['name'] );
111 | $this->assertEquals( $wp_settings_fields[ $slug ][ $section_name ][ $field['name'] ]['title'], $field['title'] );
112 | $this->assertEquals( $wp_settings_fields[ $slug ][ $section_name ][ $field['name'] ]['callback'], $field['callback'] );
113 |
114 | }
115 | }
116 | }
117 |
118 | public function test_register_settings_remove_default_settings() {
119 |
120 | add_filter( 'segment_default_settings', function( $settings ) {
121 | unset( $settings['general'] );
122 |
123 | return $settings;
124 | } );
125 |
126 | $this->assertArrayNotHasKey( 'general', $this->object->_get_default_settings() );
127 | }
128 |
129 | public function test_register_settings_add_default_settings() {
130 |
131 | add_filter( 'segment_default_settings', function( $settings ) {
132 |
133 | $settings['third-party'] = array(
134 | 'title' => '',
135 | 'callback' => '',
136 | 'fields' => array()
137 | );
138 |
139 | return $settings;
140 | } );
141 |
142 | $this->assertArrayHasKey( 'third-party', $this->object->_get_default_settings() );
143 | }
144 |
145 | public function test_logged_out_user_does_not_identify() {
146 | wp_set_current_user( 0 );
147 | $this->assertFalse( $this->object->get_current_user_identify() );
148 | }
149 |
150 | public function test_logged_in_user_identify() {
151 | wp_set_current_user( $this->factory->user->create( array( 'role' => 'subscriber' ) ) );
152 | $this->assertNotEmpty( $this->object->get_current_user_identify() );
153 | }
154 |
155 | }
156 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 | Analytics for WordPress — by Segment
2 | ====================================
3 |
4 | > **NOTE**: Official support from Segment for this plugin is **deprecated**. We are currently looking for community maintainers. The current version of this plugin should be free of bugs but any existing and future development will be paused for the time being. We recommend exploring and using third party alternatives. If you have any questions or have interest in stewarding the Segment Wordpress plugin, please send us an email at friends@segment.com!
5 |
6 | Contributors: segmentio, JustinSainton
7 | Tags: analytics, web analytics, segment.io, google analytics, kissmetrics, mixpanel, chartbeat, hubspot, marketo, quantcast, tag manager
8 | Requires at least: 3.6
9 | Tested up to: 4.0
10 | Stable tag: 1.0.14
11 | License: GPLv2
12 | License URI: http://www.gnu.org/licenses/gpl-2.0.html
13 |
14 | Analytics for WordPress lets you integrate more than 100 analytics and marketing tools with the flick of a switch.
15 |
16 | ## Description
17 |
18 | Analytics for WordPress is the easiest way to integrate analytics and marketing tools into your WordPress site.
19 |
20 | Instead of installing each tool individually, just install Segment's WordPress plugin and use Segment to integrate third-party analytics and marketing tools. Once you're setup, you can swap and add new analytics services with the flick of a switch!
21 |
22 | ## Here's how it works:
23 | * Install the Segment plugin
24 | * Segment will automatically start tracking how people are using your site – what pages they view and the information they provide to you, like their emails
25 | * Go to the Segment control panel, and toggle on any tool you want to try like Google Analytics, KISSmetrics and Facebook Audiences
26 | * Segment will send this data along to each tool
27 | * The service is fully integrated into your site–zero code required!
28 |
29 | You can use Segment to try out more than a hundred vendors in a number of categories. Here are just a few of our most popular integrations:
30 | * **Advertising** – AdRoll, Google Adwords, Facebook Audiences, Twitter Ads, Quantcast, AppNexus
31 | * **Analytics** – Google Analytics, KISSmetrics, Mixpanel, Amplitude, Chartbeat, Go Squared
32 | * **CRM** – Salesforce, Zendesk, Gainsight, Frontleaf
33 | * **Email** – Customer.io, Outbound, Vero, Marketo, MailChimp, Hubspot
34 | * **Optimization** – Optimizely, CrazyEgg, Visual Website Optimizer
35 |
36 | Get started with Analytics for WordPress today!
37 |
38 | ## Installation
39 |
40 | 1. Go to the **Plugins > Add New** page in your WordPress admin.
41 | 1. Search for "Segment" and install **Analytics for WordPress — by Segment.io**.
42 | 1. Click **Activate Plugin**.
43 | 1. Go to **Settings > Analytics** and enter your Segment API key. (If you haven't signed up for Segment yet, now's the time!)
44 |
45 | That's it! You can now turn on any analytics service with the flick of a switch in the Segment control panel.
46 |
47 |
48 | ## Frequently Asked Questions
49 |
50 | - What analytics services does it support? =
51 | Tons! Google Analytics, Mixpanel, KISSmetrics, Chartbeat, Clicky, Intercom, CrazyEgg, Customer.io, Gauges, GoSquared, HubSpot, Marketo, Olark, Quantcast, Vero, and more... You can check out [the full list](https://segment.io/integrations).
52 |
53 | - What user information does it record automatically? =
54 | We automatically identify users that are logged in to your WordPress site, and record their `name`, `email`, `username`, and `website`, so you don't need to write any special code to handle that yourself. It also identifies commenters if it can.
55 |
56 | - Which actions does it record automatically? =
57 | We automatically record the different types of WordPress pages your users can visit. Things like "View About Page", "View Post", "View Author Page", etc. So you don't have to worry about recording them yourself. Just by enabling the plugin you'll already be recording all of those actions.
58 |
59 | - Can I turn off the automatic event tracking? =
60 | Yup! You can also turn off specific events, in case you only want a few.
61 |
62 | - Can I ignore logged-in users? =
63 | Yup! You can even _just_ ignore Administrators or Editors too.
64 |
65 | - I'm a developer, what should I know? =
66 |
67 | Lots of new goodies for developers in the 1.0.0 release!
68 |
69 | So very much. The two biggest enhancements for developers are the introduction of the `segment_get_current_user_identify` and `segment_get_current_page_track` filters. As a developer, you can hook into these filters and add any sort of conditional logic you want to track any event on a page, or customize the user identification system to hook into your own user system as needed. Super extensible!
70 |
71 | Beyond that, we've completely refactored the plugin to use all of the appropriate WordPress APIs (Like the Settings API) and have added a easily extendable abstract class for eCommerce platforms. On top of all of that, all of our filters, classes, functions and methods are fully documented inline.
72 |
73 | Need to add custom settings? By hooking into our `segment_default_settings` and `segment_settings_core_validation` filters, you can quickly and easily add your own settings to the Segment plugin.
74 |
75 |
76 | ## Screenshots
77 |
78 |
79 | ## Changelog
80 |
81 | = 1.0.14 =
82 |
83 | * Fix Google Analytics nonInteraction bug
84 |
85 | = 1.0.6 =
86 | * Bump snippet to version 3.0.0
87 | * Fix for category retrieval bug
88 |
89 | = 1.0.5 =
90 | * Add context information to page calls.
91 |
92 | = 1.0.4 =
93 | * Fixed identify() method to only be called for logged-in users and commenters.
94 |
95 | = 1.0.3 =
96 | * Fixed deployment logic
97 |
98 | = 1.0.2 =
99 | * Fixed deployment logic
100 |
101 | = 1.0.1 =
102 | * Fixed fatal error when tracking WooCommerce products.
103 |
104 | = 1.0.0 =
105 | * Total refactor for WordPress plugin best practices.
106 | * Addition of several helpful filters.
107 | * Now sends category data for posts.
108 | * New options to allow you to track user logins.
109 | * Added eCommerce tracking for WP eCommerce and WooCommerce.
110 | * Added Intercom Secure Mode support.
111 |
112 | = 0.5.6 =
113 | * Fixed a bug with non-static methods in newer versions on PHP.
114 |
115 | = 0.5.5 =
116 | * Fixed a bug where admins weren't being properly ignored.
117 |
118 | = 0.5.3 =
119 | * Fixed a bug that occured in older versions of PHP.
120 |
121 | = 0.5.2 =
122 | * Added `'analytics-wordpress'` `library` option.
123 |
124 | = 0.5.1 =
125 | * Fixed a bug where the user permission level would be output.
126 |
127 | = 0.5.0 =
128 | * Added setting to ignore users by permission level (eg. Administrators).
129 |
130 | = 0.4.3 =
131 | * Made our page view events `noninteraction` in Google Analytics.
132 |
133 | = 0.4.0 =
134 | * Added settings to turn off automatic event tracking.
135 |
136 | = 0.3.3 =
137 | * Fixed a bug that occured on uncommon page types.
138 |
139 | = 0.3.2 =
140 | * Fixed a bug that occured when installing straight from WordPress admin.
141 |
142 | = 0.3.0 =
143 | * Exposed a global `Analytics` class for custom tracking.
144 |
145 | = 0.2.0 =
146 | * Added identifying commenters.
147 | * Added tracking events for different page types.
148 | * Bug fixes.
149 |
150 | = 0.1.0 =
151 | * Initial release!
152 |
--------------------------------------------------------------------------------
/integrations/ecommerce/wp-e-commerce.php:
--------------------------------------------------------------------------------
1 | register_hook( 'segment_get_current_page' , 'viewed_category' , 1, $this );
21 | $this->register_hook( 'segment_get_current_page_track', 'viewed_product' , 1, $this );
22 | $this->register_hook( 'segment_get_current_page_track', 'completed_order' , 1, $this );
23 | $this->register_hook( 'segment_get_current_page_track', 'added_to_cart' , 2, $this );
24 | $this->register_hook( 'segment_get_current_page_track', 'removed_from_cart', 2, $this );
25 |
26 | /* HTTP actions */
27 | add_action( 'wpsc_add_to_cart', array( $this, 'add_to_cart' ), 10, 2 );
28 |
29 | /* When WPeC 3.9 is the min. version for this plugin, we'll use `wpsc_remove_item` */
30 | add_action( 'wpsc_refresh_item', array( $this, 'remove_from_cart' ), 10 );
31 |
32 | }
33 |
34 | /**
35 | * Adds category name to analytics.page()
36 | *
37 | * @since 1.0.0
38 | * @access public
39 | *
40 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
41 | * for each different platform, we use func_get_args().
42 | *
43 | * @return array Filtered array of name and properties for analytics.page().
44 | */
45 | public function viewed_category() {
46 |
47 | $args = func_get_args();
48 | $page = $args[0];
49 |
50 | if ( is_tax( 'wpsc_product_category' ) ) {
51 | $page = array(
52 | 'page' => single_term_title( '', false ),
53 | 'properties' => array()
54 | );
55 | }
56 |
57 | return $page;
58 | }
59 | /**
60 | * Adds product information to a Segment_Cookie when item is added to cart.
61 | *
62 | * @param string $key Key name for item in cart. A hash.
63 | * @param int $id Product ID
64 | * @param int $quantity Item quantity
65 | *
66 | * @since 1.0.0
67 | * @access public
68 | *
69 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
70 | * for each different platform, we use func_get_args().
71 | */
72 | /**
73 | * Adds product properties to analytics.track() when product is viewed.
74 | *
75 | * @since 1.0.0
76 | * @access public
77 | *
78 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
79 | * for each different platform, we use func_get_args().
80 | *
81 | * @return array Filtered array of name and properties for analytics.track().
82 | */
83 | public function viewed_product() {
84 |
85 | $args = func_get_args();
86 | $track = $args[0];
87 |
88 | if ( is_singular( 'wpsc-product' ) ) {
89 | $track = array(
90 | 'event' => __( 'Viewed Product', 'segment' ),
91 | 'properties' => array(
92 | 'id' => get_the_ID(),
93 | 'sku' => wpsc_product_sku(),
94 | 'name' => wpsc_the_product_title(),
95 | 'price' => wpsc_string_to_float( wpsc_the_product_price() ),
96 | 'category' => implode( ', ', wp_list_pluck( wpsc_get_product_terms( get_the_ID(), 'wpsc_product_category' ), 'name' ) ),
97 | )
98 | );
99 | }
100 |
101 | return $track;
102 | }
103 |
104 | /**
105 | * Adds product information to a Segment_Cookie when item is added to cart.
106 | *
107 | * @param string $key Key name for item in cart. A hash.
108 | * @param int $id Product ID
109 | * @param int $quantity Item quantity
110 | *
111 | * @since 1.0.0
112 | * @access public
113 | *
114 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
115 | * for each different platform, we use func_get_args().
116 | */
117 | public function add_to_cart( $product, $cart_item ) {
118 |
119 | Segment_Cookie::set_cookie( 'added_to_cart', json_encode(
120 | array(
121 | 'ID' => $product->ID,
122 | 'quantity' => $cart_item->quantity,
123 | 'name' => $product->post_title,
124 | 'price' => $cart_item->unit_price
125 | )
126 | )
127 | );
128 | }
129 |
130 | /**
131 | * Adds product properties to analytics.track() when product added to cart.
132 | *
133 | * @since 1.0.0
134 | * @access public
135 | *
136 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
137 | * for each different platform, we use func_get_args().
138 | *
139 | * @return array Filtered array of name and properties for analytics.track().
140 | */
141 | public function added_to_cart() {
142 | $args = func_get_args();
143 |
144 | $track = $args[0];
145 |
146 | if ( false !== ( $product = Segment_Cookie::get_cookie( 'added_to_cart' ) ) ) {
147 |
148 | $product = json_decode( $product );
149 |
150 | $item = array(
151 | 'id' => $product->ID,
152 | 'sku' => wpsc_product_sku( $product->ID ),
153 | 'name' => $product->name,
154 | 'price' => $product->price,
155 | 'quantity' => $product->quantity,
156 | 'category' => implode( ', ', wp_list_pluck( wpsc_get_product_terms( $product->ID, 'wpsc_product_category' ), 'name' ) ),
157 | );
158 |
159 | $track = array(
160 | 'event' => __( 'Added Product', 'segment' ),
161 | 'properties' => $item,
162 | 'http_event' => 'added_to_cart'
163 | );
164 |
165 | }
166 |
167 | return $track;
168 | }
169 |
170 | /**
171 | * Adds product information to a Segment_Cookie when item is removed from cart.
172 | *
173 | * @param string $key Key name for item in cart. A hash.
174 | *
175 | * @since 1.0.0
176 | * @access public
177 | *
178 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
179 | * for each different platform, we use func_get_args().
180 | */
181 | public function remove_from_cart( $cart_item ) {
182 | if ( 0 == $cart_item->quantity ) {
183 | Segment_Cookie::set_cookie( 'removed_from_cart', json_encode(
184 | array(
185 | 'ID' => $cart_item->product_id,
186 | 'quantity' => 0,
187 | 'name' => $cart_item->product_title,
188 | 'price' => $cart_item->unit_price
189 | )
190 | )
191 | );
192 | }
193 |
194 | }
195 |
196 | /**
197 | * Adds product properties to analytics.track() when product is removed from cart.
198 | *
199 | * @since 1.0.0
200 | * @access public
201 | *
202 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
203 | * for each different platform, we use func_get_args().
204 | *
205 | * @return array Filtered array of name and properties for analytics.track().
206 | */
207 | public function removed_from_cart() {
208 | $args = func_get_args();
209 |
210 | $track = $args[0];
211 |
212 | if ( false !== ( $product = Segment_Cookie::get_cookie( 'removed_from_cart' ) ) ) {
213 |
214 | $product = json_decode( $product );
215 |
216 | $item = array(
217 | 'id' => $product->ID,
218 | 'sku' => wpsc_product_sku( $product->ID ),
219 | 'name' => $product->name,
220 | 'price' => $product->price,
221 | 'quantity' => 0,
222 | 'category' => implode( ', ', wp_list_pluck( wpsc_get_product_terms( $product->ID, 'wpsc_product_category' ), 'name' ) ),
223 | );
224 |
225 | $track = array(
226 | 'event' => __( 'Removed Product', 'segment' ),
227 | 'properties' => $item,
228 | 'http_event' => 'removed_from_cart'
229 | );
230 |
231 | }
232 |
233 | return $track;
234 | }
235 |
236 | /**
237 | * Adds product properties to analytics.track() when the order is completed successfully.
238 | *
239 | * @since 1.0.0
240 | * @access public
241 | *
242 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
243 | * for each different platform, we use func_get_args().
244 | *
245 | * @return array Filtered array of name and properties for analytics.track().
246 | */
247 | public function completed_order() {
248 | $args = func_get_args();
249 | $track = $args[0];
250 |
251 | if ( did_action( 'wpsc_transaction_results_shutdown' ) && isset( $_GET['sessionid'] ) ) {
252 |
253 | $log = new WPSC_Purchase_Log( $_GET['sessionid'], 'sessionid' );
254 |
255 | /* We like checking is_order_received(), as that's what the manual payment gateway uses. */
256 | if ( $log->is_transaction_completed() || $log->is_order_received() ) {
257 |
258 | $gateway_data = $log->get_gateway_data();
259 | $items = $log->get_cart_contents();
260 | $products = array();
261 |
262 | foreach ( $items as $item ) {
263 |
264 | $product = array(
265 | 'id' => $item->prodid,
266 | 'sku' => wpsc_product_sku( $item->prodid ),
267 | 'name' => $item->name,
268 | 'price' => $item->price,
269 | 'quantity' => $item->quantity,
270 | 'category' => implode( ', ', wp_list_pluck( wpsc_get_product_terms( $item->prodid, 'wpsc_product_category' ), 'name' ) ),
271 | );
272 |
273 | $products[] = $product;
274 |
275 | }
276 |
277 | $track = array(
278 | 'event' => __( 'Completed Order', 'segment' ),
279 | 'properties' => array(
280 | 'id' => $log->get( 'id' ) ,
281 | 'total' => $log->get( 'totalprice' ),
282 | 'revenue' => $gateway_data['subtotal'],
283 | 'shipping' => $gateway_data['shipping'],
284 | 'tax' => $gateway_data['tax'],
285 | 'products' => $products
286 | )
287 | );
288 |
289 | }
290 | }
291 |
292 | return $track;
293 | }
294 |
295 | }
296 | /**
297 | * Bootstrapper for the Segment_Commerce_WPSC class.
298 | *
299 | * @since 1.0.0
300 | */
301 |
302 | function segment_commerce_wpsc() {
303 | $commerce = new Segment_Commerce_WPSC();
304 |
305 | return $commerce->init();
306 | }
307 |
308 | add_action( 'plugins_loaded', 'segment_commerce_wpsc', 100 );
--------------------------------------------------------------------------------
/includes/class.segment-settings.php:
--------------------------------------------------------------------------------
1 |
7 |
8 |
13 |
14 | get_settings();
20 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[api_key]';
21 | ?>
22 |
23 |
API Keys in your Segment.io Dashboard.', 'segment' ); ?>
24 | get_settings();
31 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[ignore_user_level]';
32 | ?>
33 |
41 |
42 | get_settings();
49 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[track_posts]';
50 | ?>
51 |
55 |
56 |
57 | get_settings();
64 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[track_pages]';
65 | ?>
66 |
70 |
71 |
72 | get_settings();
79 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[track_archives]';
80 | ?>
81 |
85 |
86 |
87 | get_settings();
94 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[track_comments]';
95 | ?>
96 |
100 |
101 |
102 | get_settings();
109 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[track_logins]';
110 | ?>
111 |
115 |
116 |
117 | get_settings();
124 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[track_login_page]';
125 | ?>
126 |
130 | get_settings();
137 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[use_intercom_secure_mode]';
138 | ?>
139 |
140 |
141 | get_settings();
147 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[track_searches]';
148 | ?>
149 |
153 |
154 | true, '_builtin' => false ), 'objects' );
166 | $settings = Segment_Analytics_WordPress::get_instance()->get_settings();
167 | $name = Segment_Analytics_WordPress::get_instance()->get_option_name() . '[exclude_custom_post_types][]';
168 |
169 | $settings['exclude_custom_post_types'] = isset( $settings['exclude_custom_post_types'] ) ? $settings['exclude_custom_post_types'] : array();
170 |
171 | foreach ( $cpts as $cpt ) {
172 | ?>
173 |
177 |
180 |
181 | register_hook( 'segment_get_current_page' , 'viewed_category' , 1, $this );
21 | $this->register_hook( 'segment_get_current_page_track', 'viewed_product' , 1, $this );
22 | $this->register_hook( 'segment_get_current_page_track', 'completed_order' , 1, $this );
23 | $this->register_hook( 'segment_get_current_page_track', 'added_to_cart' , 2, $this );
24 | $this->register_hook( 'segment_get_current_page_track', 'removed_from_cart', 2, $this );
25 |
26 | /* HTTP actions */
27 | add_action( 'woocommerce_add_to_cart' , array( $this, 'add_to_cart' ) , 10, 3 );
28 | add_action( 'woocommerce_before_cart_item_quantity_zero', array( $this, 'remove_from_cart' ), 10 );
29 | }
30 |
31 | /**
32 | * Adds category name to analytics.page()
33 | *
34 | * @since 1.0.0
35 | * @access public
36 | *
37 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
38 | * for each different platform, we use func_get_args().
39 | *
40 | * @return array Filtered array of name and properties for analytics.page().
41 | */
42 | public function viewed_category() {
43 |
44 | $args = func_get_args();
45 | $page = $args[0];
46 |
47 | if ( is_tax( 'product_cat' ) ) {
48 | $page = array(
49 | 'page' => single_term_title( '', false ),
50 | 'properties' => array()
51 | );
52 | }
53 |
54 | return $page;
55 | }
56 |
57 | /**
58 | * Adds product properties to analytics.track() when product is viewed.
59 | *
60 | * @since 1.0.0
61 | * @access public
62 | *
63 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
64 | * for each different platform, we use func_get_args().
65 | *
66 | * @return array Filtered array of name and properties for analytics.track().
67 | */
68 | public function viewed_product() {
69 |
70 | $args = func_get_args();
71 | $track = $args[0];
72 |
73 | if ( is_singular( 'product' ) ) {
74 |
75 | $product = get_product( get_queried_object_id() );
76 |
77 | $track = array(
78 | 'event' => __( 'Viewed Product', 'segment' ),
79 | 'properties' => array(
80 | 'id' => $product->id,
81 | 'sku' => $product->get_sku(),
82 | 'name' => $product->get_title(),
83 | 'price' => $product->get_price(),
84 | 'category' => implode( ', ', wp_list_pluck( wc_get_product_terms( $product->ID, 'product_cat' ), 'name' ) ),
85 | )
86 | );
87 | }
88 |
89 | return $track;
90 | }
91 |
92 | /**
93 | * Adds product information to a Segment_Cookie when item is added to cart.
94 | *
95 | * @param string $key Key name for item in cart. A hash.
96 | * @param int $id Product ID
97 | * @param int $quantity Item quantity
98 | *
99 | * @since 1.0.0
100 | * @access public
101 | *
102 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
103 | * for each different platform, we use func_get_args().
104 | */
105 | public function add_to_cart( $key, $id, $quantity ) {
106 |
107 | if ( ! is_object( WC()->cart ) ) {
108 | return;
109 | }
110 |
111 | $items = WC()->cart->get_cart();
112 | $cart_item = $items[ $key ];
113 |
114 | if ( ! is_object( $cart_item ) ) {
115 | return;
116 | }
117 |
118 | Segment_Cookie::set_cookie( 'added_to_cart', json_encode(
119 | array(
120 | 'ID' => $id,
121 | 'quantity' => $quantity,
122 | 'name' => $cart_item['data']->post->post_title,
123 | 'price' => $cart_item['data']->get_price(),
124 | 'key' => $key
125 | )
126 | )
127 | );
128 |
129 | }
130 |
131 | /**
132 | * Adds product properties to analytics.track() when product added to cart.
133 | *
134 | * @since 1.0.0
135 | * @access public
136 | *
137 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
138 | * for each different platform, we use func_get_args().
139 | *
140 | * @return array Filtered array of name and properties for analytics.track().
141 | */
142 | public function added_to_cart() {
143 | $args = func_get_args();
144 |
145 | $track = $args[0];
146 |
147 | if ( false !== ( $cookie = Segment_Cookie::get_cookie( 'added_to_cart' ) ) ) {
148 |
149 | if ( ! is_object( WC()->cart ) ) {
150 | return $track;
151 | }
152 |
153 | $_product = json_decode( $cookie );
154 |
155 | if ( is_object( $_product ) ) {
156 | $product = get_product( $_product->ID );
157 |
158 | if ( $product ) {
159 | $item = array(
160 | 'id' => $product->id,
161 | 'sku' => $product->get_sku(),
162 | 'name' => $product->get_title(),
163 | 'price' => $product->get_price(),
164 | 'quantity' => $_product->quantity,
165 | 'category' => implode( ', ', wp_list_pluck( wc_get_product_terms( $product->id, 'product_cat' ), 'name' ) ),
166 | );
167 |
168 | $track = array(
169 | 'event' => __( 'Added Product', 'segment' ),
170 | 'properties' => $item,
171 | 'http_event' => 'added_to_cart'
172 | );
173 | }
174 | }
175 |
176 | }
177 |
178 | return $track;
179 | }
180 |
181 | /**
182 | * Adds product information to a Segment_Cookie when item is removed from cart.
183 | *
184 | * @param string $key Key name for item in cart. A hash.
185 | *
186 | * @since 1.0.0
187 | * @access public
188 | *
189 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
190 | * for each different platform, we use func_get_args().
191 | */
192 | public function remove_from_cart( $key ) {
193 |
194 | if ( ! is_object( WC()->cart ) ) {
195 | return;
196 | }
197 |
198 | $items = WC()->cart->get_cart();
199 | $cart_item = $items[ $key ];
200 |
201 | if ( ! is_object( $cart_item ) ) {
202 | return;
203 | }
204 |
205 | Segment_Cookie::set_cookie( 'removed_from_cart', json_encode(
206 | array(
207 | 'ID' => $cart_item->product_id,
208 | 'quantity' => 0,
209 | 'name' => $cart_item['data']->post->post_title,
210 | 'price' => $cart_item['data']->get_price(),
211 | 'key' => $key
212 | )
213 | )
214 | );
215 | }
216 |
217 | /**
218 | * Adds product properties to analytics.track() when product is removed from cart.
219 | *
220 | * @since 1.0.0
221 | * @access public
222 | *
223 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
224 | * for each different platform, we use func_get_args().
225 | *
226 | * @return array Filtered array of name and properties for analytics.track().
227 | */
228 | public function removed_from_cart() {
229 | $args = func_get_args();
230 |
231 | $track = $args[0];
232 |
233 | if ( false !== ( $cookie = Segment_Cookie::get_cookie( 'removed_from_cart' ) ) ) {
234 |
235 | if ( ! is_object( WC()->cart ) ) {
236 | return $track;
237 | }
238 |
239 | $_product = json_decode( $cookie );
240 |
241 | if ( is_object( $_product ) ) {
242 | $product = get_product( $_product->ID );
243 |
244 | if ( $product ) {
245 | $item = array(
246 | 'id' => $product->ID,
247 | 'sku' => $product->get_sku(),
248 | 'name' => $product->get_title(),
249 | 'price' => $product->get_price(),
250 | 'quantity' => 0,
251 | 'category' => implode( ', ', wp_list_pluck( wc_get_product_terms( $product->ID, 'product_cat' ), 'name' ) ),
252 | );
253 |
254 | $track = array(
255 | 'event' => __( 'Removed Product', 'segment' ),
256 | 'properties' => $item,
257 | 'http_event' => 'removed_from_cart'
258 | );
259 | }
260 | }
261 | }
262 |
263 | return $track;
264 | }
265 |
266 | /**
267 | * Adds product properties to analytics.track() when the order is completed successfully.
268 | *
269 | * @since 1.0.0
270 | * @access public
271 | *
272 | * @uses func_get_args() Because our abstract class doesn't know how many parameters are passed to each hook
273 | * for each different platform, we use func_get_args().
274 | *
275 | * @return array Filtered array of name and properties for analytics.track().
276 | */
277 | public function completed_order() {
278 | $args = func_get_args();
279 | $track = $args[0];
280 |
281 | if ( did_action( 'woocommerce_thankyou' ) ) {
282 |
283 | $order_number = get_query_var( 'order-received' );
284 |
285 | $order = new WC_Order( $order_number );
286 |
287 | /* Because gateways vary wildly in their usage of the status concept, we check for failure rather than success. */
288 | if ( 'failed' !== $order->status ) {
289 |
290 | $items = $order->get_items();
291 | $products = array();
292 |
293 | foreach ( $items as $item ) {
294 | $_product = $order->get_product_from_item( $item );
295 | $product = array(
296 | 'id' => $item->product_id,
297 | 'sku' => $_product->get_sku(),
298 | 'name' => $item['name'],
299 | 'price' => $item['line_subtotal'],
300 | 'quantity' => $item['qty'],
301 | 'category' => implode( ', ', wp_list_pluck( wc_get_product_terms( $item->product_id, 'product_cat' ), 'name' ) ),
302 | );
303 |
304 | $products[] = $product;
305 |
306 | }
307 |
308 | $track = array(
309 | 'event' => __( 'Completed Order', 'segment' ),
310 | 'properties' => array(
311 | 'id' => $order->get_order_number(),
312 | 'total' => $order->get_total(),
313 | 'revenue' => $order->get_total() - ( $order->get_total_shipping() + $order->get_total_tax() ),
314 | 'shipping' => $order->get_total_shipping(),
315 | 'tax' => $order->get_total_tax(),
316 | 'products' => $products
317 | )
318 | );
319 |
320 | }
321 | }
322 |
323 | return $track;
324 | }
325 |
326 | }
327 |
328 | /**
329 | * Bootstrapper for the Segment_Commerce_Woo class.
330 | *
331 | * @since 1.0.0
332 | */
333 | function segment_commerce_woo() {
334 | $commerce = new Segment_Commerce_Woo();
335 |
336 | return $commerce->init();
337 | }
338 |
339 | add_action( 'plugins_loaded', 'segment_commerce_woo', 100 );
--------------------------------------------------------------------------------
/license.txt:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 |
294 | Copyright (C)
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | , 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
--------------------------------------------------------------------------------
/analytics-wordpress.php:
--------------------------------------------------------------------------------
1 | setup_constants();
37 |
38 | if ( ! has_action( 'plugins_loaded', array( self::$instance, 'include_deprecated_files' ) ) ) {
39 | add_action( 'plugins_loaded', array( self::$instance, 'include_deprecated_files' ), 20 );
40 | }
41 |
42 | }
43 |
44 | return self::$instance;
45 | }
46 |
47 | /**
48 | * Sets up constants for file paths, folders, URLs and directory names related to the plugin.
49 | *
50 | * @since 1.0.0
51 | */
52 | public function setup_constants() {
53 |
54 | // Set the core file path
55 | define( 'SEG_FILE_PATH', dirname( __FILE__ ) );
56 |
57 | // Define the path to the plugin folder
58 | define( 'SEG_DIR_NAME', basename( SEG_FILE_PATH ) );
59 |
60 | // Define the URL to the plugin folder
61 | define( 'SEG_FOLDER', dirname( plugin_basename( __FILE__ ) ) );
62 | define( 'SEG_URL' , plugins_url( '', __FILE__ ) );
63 |
64 | }
65 |
66 | /**
67 | * Includes deprecated files, specifically our old class names.
68 | * They simply extend their replacement classes and are only includes if other plugins do not define those classes.
69 | *
70 | * @since 1.0.0
71 | */
72 | public function include_deprecated_files() {
73 |
74 | // Include old files for back compat
75 | include_once( SEG_FILE_PATH . '/includes/class.analytics.php' );
76 | include_once( SEG_FILE_PATH . '/includes/class.analytics-wordpress.php' );
77 |
78 | }
79 |
80 | /**
81 | * Render the Segment.io Javascript snippet.
82 | *
83 | * @since 1.0.0
84 | *
85 | * @param array $settings Settings options array.
86 | * @param bool $ignore Whether or not to ignore the call and avoid outputting the API key snippet.
87 | */
88 | public static function initialize( $settings, $ignore = false ) {
89 |
90 | if ( ! isset( $settings['api_key'] ) || $settings['api_key'] == '' ) {
91 | return;
92 | }
93 |
94 | include_once( SEG_FILE_PATH . '/templates/snippet.php' );
95 |
96 | }
97 |
98 | /**
99 | * Render a Javascript `identify` call
100 | *
101 | * @since 1.0.0
102 | *
103 | * @param int|string $user_id Current User ID.
104 | * Generated via get_current_user_id() if logged in, anonymous user ID if not.
105 | * @param array $traits Array of traits to pass to Segment.
106 | * @param array $options Array of options to pass to Segment.
107 | */
108 | public static function identify( $user_id, $traits = array(), $options = array() ) {
109 |
110 | // Set the proper `library` option so we know where the API calls come from.
111 | $options['library'] = 'analytics-wordpress';
112 |
113 | include_once( SEG_FILE_PATH. '/templates/identify.php' );
114 | }
115 |
116 | /**
117 | * Render a Javascript `track` call
118 | *
119 | * @since 1.0.0
120 | *
121 | * @param string $event The name of the event to pass to Segment.
122 | * @param array $properties An array of properties to pass to Segment.
123 | * @param array $options An array of options to pass to Segment.
124 | * @param boolean $http_event Whether or not the event is occurring over HTTP, as opposed to on page load.
125 | * This is helpful to track events that occur between page loads, like commenting.
126 | *
127 | */
128 | public static function track( $event, $properties = array(), $options = array(), $http_event = false ) {
129 |
130 | // Set the proper `library` option so we know where the API calls come from.
131 | $options['library'] = 'analytics-wordpress';
132 |
133 | include_once( SEG_FILE_PATH . '/templates/track.php' );
134 | }
135 |
136 | /**
137 | * Render a Javascript `page` call
138 | *
139 | * @since 1.0.0
140 | *
141 | * @param string $category Category (or name) of event
142 | * @param string $name Optional, but if set, category must be set as well.
143 | * @param array $properties An array of properties to pass to Segment.
144 | * @param array $options An array of options to pass to Segment.
145 | * @param boolean $http_event Whether or not the event is occurring over HTTP, as opposed to on page load.
146 | * This is helpful to track events that occur between page loads, like commenting.
147 | */
148 | public static function page( $category = '', $name = '', $properties = array(), $options = array(), $http_event = false ) {
149 |
150 | // Set the proper `library` option so we know where the API calls come from.
151 | $options['library'] = 'analytics-wordpress';
152 |
153 | include_once( SEG_FILE_PATH . '/templates/page.php' );
154 |
155 | }
156 |
157 | /**
158 | * Creates an alias between an anonymous ID and a newly created user ID.
159 | * Primarily used for MixPanel.
160 | *
161 | * @since 1.0.0
162 | *
163 | * @param int|string $from The anonymous ID that we're aliasing from.
164 | * @param int|string $to The newly created User ID we are aliasing to.
165 | * @param string $context Optional context parameter to be passed to Segment.
166 | */
167 | public static function alias( $from, $to, $context = '' ) {
168 |
169 | include_once( SEG_FILE_PATH . '/templates/alias.php' );
170 | }
171 |
172 | }
173 |
174 | class Segment_Analytics_WordPress {
175 |
176 | /**
177 | * Slug used in page and menu names
178 | */
179 | const SLUG = 'analytics';
180 |
181 | /**
182 | * Current plugin version.
183 | */
184 | const VERSION = '1.0.13';
185 |
186 | /**
187 | * The singleton instance of Segment_Analytics_WordPress.
188 | *
189 | * @access private
190 | * @var Segment_Analytics_WordPress
191 | * @since 1.0.0
192 | */
193 | private static $instance;
194 |
195 | /**
196 | * The singleton instance of Segment_Analytics, for use in our class.
197 | *
198 | * @access private
199 | * @var Segment_Analytics
200 | * @since 1.0.0
201 | */
202 | private $analytics;
203 |
204 | /**
205 | * The name of our options array.
206 | *
207 | * @access private
208 | * @var string
209 | * @since 1.0.0
210 | */
211 | private $option = 'analytics_wordpress_options';
212 |
213 | /**
214 | * The default values for our options array.
215 | *
216 | * Not used since 1.0.0, outside of activation hooks, with our move to the Settings API.
217 | * See Segment_Analytics_WordPress::register_settings().
218 | *
219 | * @access public
220 | * @var array
221 | * @since 1.0.0
222 | */
223 | public $defaults = array(
224 |
225 | // Your Segment.io API key that we'll use to initialize analytics.js.
226 | 'api_key' => '',
227 |
228 | // Whether or not we should ignore users of above a certain permissions
229 | // level. (eg. `11` ignores nobody and `8` ignores Administrators)
230 | 'ignore_user_level' => 11,
231 |
232 | // Whether or not we should track events for posts. This also includes
233 | // custom post types, for example a Product post type.
234 | 'track_posts' => 1,
235 |
236 | // Whether or not we should track events for pages. This includes the
237 | // Home page and things like the About page, Contact page, etc.
238 | 'track_pages' => 1,
239 |
240 | // Whether or not we should track custom events for archive pages like
241 | // the Category archive or the Author archive.
242 | 'track_archives' => 1,
243 |
244 | // Whether or not we should track custom events for comments
245 | 'track_comments' => 1,
246 |
247 | // Whether or not we should use Intercom's Secure Mode
248 | 'use_intercom_secure_mode' => '',
249 |
250 | // Whether or not we should track custom events for searches
251 | 'track_searches' => 1,
252 |
253 | // Whether or not we should track custom events for users logging in
254 | 'track_logins' => 1,
255 |
256 | // Whether or not we should track custom events for viewing the logged in page.
257 | 'track_login_page' => false,
258 |
259 | // Whether or not we should track custom events for the Search page.
260 | 'exclude_custom_post_types' => array(),
261 | );
262 |
263 | /**
264 | * Retrieves the one true instance of Segment_Analytics_WordPress
265 | *
266 | * @since 1.0.0
267 | * @return object Singleton instance of Segment_Analytics_WordPress
268 | */
269 | public static function get_instance() {
270 |
271 | if ( ! isset( self::$instance ) && ! ( self::$instance instanceof Segment_Analytics_WordPress ) ) {
272 |
273 | self::$instance = new Segment_Analytics_WordPress;
274 |
275 | self::$instance->load_textdomain();
276 | self::$instance->admin_hooks();
277 | self::$instance->frontend_hooks();
278 |
279 | self::$instance->analytics = Segment_Analytics::get_instance();
280 |
281 | self::$instance->include_files();
282 | }
283 |
284 | return self::$instance;
285 | }
286 |
287 | /**
288 | * Returns Settings option name.
289 | *
290 | * @since 1.0.0
291 | *
292 | * @return string Settings option name
293 | */
294 | public function get_option_name() {
295 | return $this->option;
296 | }
297 |
298 | /**
299 | * Hooks into actions and filters that affect the administration areas.
300 | *
301 | * @since 1.0.0
302 | */
303 | public function admin_hooks() {
304 | add_action( 'admin_menu' , array( self::$instance, 'admin_menu' ) );
305 | add_filter( 'plugin_action_links', array( self::$instance, 'plugin_action_links' ), 10, 2 );
306 | add_filter( 'plugin_row_meta' , array( self::$instance, 'plugin_row_meta' ) , 10, 2 );
307 | add_action( 'admin_init' , array( self::$instance, 'register_settings' ) );
308 | }
309 |
310 | /**
311 | * Includes core classes.
312 | * Currently includes Segment_Cookie and eCommerce bootstrap.
313 | *
314 | * @uses do_action() Allows other plugins to hook in before or after everything is bootstrapped.
315 | *
316 | * @since 1.0.0
317 | */
318 | public function include_files() {
319 |
320 | do_action( 'segment_pre_include_files', self::$instance );
321 |
322 | include_once( SEG_FILE_PATH . '/includes/class.segment-settings.php' );
323 | include_once( SEG_FILE_PATH . '/includes/class.segment-cookie.php' );
324 | include_once( SEG_FILE_PATH . '/integrations/ecommerce.php' );
325 | include_once( SEG_FILE_PATH . '/integrations/intercom.php' );
326 |
327 | do_action( 'segment_include_files', self::$instance );
328 | }
329 |
330 | /**
331 | * Hooks into actions and filters that affect the front-end.
332 | * That is to say, this is where the magic happens.
333 | *
334 | * @since 1.0.0
335 | */
336 | public function frontend_hooks() {
337 |
338 | add_action( 'wp_head' , array( self::$instance, 'wp_head' ) , 9 );
339 | add_action( 'admin_head' , array( self::$instance, 'wp_head' ) , 9 );
340 | add_action( 'login_head' , array( self::$instance, 'wp_head' ) , 9 );
341 | add_action( 'wp_footer' , array( self::$instance, 'wp_footer' ) , 9 );
342 | add_action( 'login_footer' , array( self::$instance, 'wp_footer' ) , 9 );
343 | add_action( 'admin_footer' , array( self::$instance, 'wp_footer' ) , 9 );
344 | add_action( 'wp_insert_comment', array( self::$instance, 'insert_comment' ), 9, 2 );
345 | add_action( 'wp_login' , array( self::$instance, 'login_event' ), 9, 2 );
346 | add_action( 'user_register' , array( self::$instance, 'user_register' ), 9 );
347 | }
348 |
349 | /**
350 | * Returns array of settings.
351 | *
352 | * @since 1.0.4
353 | */
354 | public function _get_default_settings() {
355 | return apply_filters( 'segment_default_settings', array(
356 | 'general' => array(
357 | 'title' => __( 'General', 'segment' ),
358 | 'callback' => array( 'Segment_Settings', 'general_section_callback' ),
359 | 'fields' => array(
360 | array(
361 | 'name' => 'api_key',
362 | 'title' => __( 'Segment API Write Key', 'segment' ),
363 | 'callback' => array( 'Segment_Settings', 'api_key_callback' ),
364 | )
365 | )
366 | ),
367 | 'advanced' => array(
368 | 'title' => __( 'Advanced Settings', 'segment' ),
369 | 'callback' => array( 'Segment_Settings', 'advanced_section_callback' ),
370 | 'fields' => array(
371 | array(
372 | 'name' => 'ignore_user_level',
373 | 'title' => __( 'Users to Ignore', 'segment' ),
374 | 'callback' => array( 'Segment_Settings', 'ignore_user_level_callback' ),
375 | ),
376 | array(
377 | 'name' => 'track_posts',
378 | 'title' => __( 'Track Posts', 'segment' ),
379 | 'callback' => array( 'Segment_Settings', 'track_posts_callback' ),
380 | ),
381 | array(
382 | 'name' => 'exclude_post_types',
383 | 'title' => __( 'Exclude Post Types', 'segment' ),
384 | 'callback' => array( 'Segment_Settings', 'exclude_custom_post_types' ),
385 | ),
386 | array(
387 | 'name' => 'track_pages',
388 | 'title' => __( 'Track Pages', 'segment' ),
389 | 'callback' => array( 'Segment_Settings', 'track_pages_callback' ),
390 | ),
391 | array(
392 | 'name' => 'track_archives',
393 | 'title' => __( 'Track Archives', 'segment' ),
394 | 'callback' => array( 'Segment_Settings', 'track_archives_callback' ),
395 | ),
396 | array(
397 | 'name' => 'track_archives',
398 | 'title' => __( 'Track Archives', 'segment' ),
399 | 'callback' => array( 'Segment_Settings', 'track_archives_callback' ),
400 | ),
401 | array(
402 | 'name' => 'track_comments',
403 | 'title' => __( 'Track Comments', 'segment' ),
404 | 'callback' => array( 'Segment_Settings', 'track_comments_callback' ),
405 | ),
406 | array(
407 | 'name' => 'track_logins',
408 | 'title' => __( 'Track Logins', 'segment' ),
409 | 'callback' => array( 'Segment_Settings', 'track_logins_callback' ),
410 | ),
411 | array(
412 | 'name' => 'track_login_page',
413 | 'title' => __( 'Track Login Page Views', 'segment' ),
414 | 'callback' => array( 'Segment_Settings', 'track_login_page_callback' ),
415 | ),
416 | array(
417 | 'name' => 'track_searches',
418 | 'title' => __( 'Track Searches', 'segment' ),
419 | 'callback' => array( 'Segment_Settings', 'track_search_callback' ),
420 | ),
421 | array(
422 | 'name' => 'use_intercom_secure_mode',
423 | 'title' => __( 'Intercom API Secret', 'segment' ),
424 | 'callback' => array( 'Segment_Settings', 'use_intercom_secure_mode' ),
425 | ),
426 | )
427 | ),
428 |
429 | )
430 | );
431 | }
432 |
433 | /**
434 | * Registers our settings, fields and sections using the WordPress Settings API.
435 | *
436 | * Developers should use the `segment_default_settings` filter to add settings.
437 | * They should also use the `segment_settings_core_validation` filter to validate
438 | * any settings they add.
439 | *
440 | * @since 1.0.0
441 | * @return void
442 | */
443 | public function register_settings() {
444 |
445 | $settings = $this->_get_default_settings();
446 |
447 | register_setting( self::SLUG, $this->get_option_name(), array( 'Segment_Settings', 'core_validation' ) );
448 |
449 | foreach ( $settings as $section_name => $section ) {
450 |
451 | add_settings_section(
452 | $section_name,
453 | $section['title'],
454 | $section['callback'],
455 | self::SLUG
456 | );
457 |
458 | foreach ( $section['fields'] as $field ) {
459 |
460 | add_settings_field(
461 | $field['name'],
462 | $field['title'],
463 | $field['callback'],
464 | self::SLUG,
465 | $section_name
466 | );
467 |
468 | }
469 | }
470 |
471 | }
472 |
473 | /**
474 | * Empty constructor, as we prefer to get_instance().
475 | *
476 | * @since 1.0.0
477 | *
478 | */
479 | public function __construct() {}
480 |
481 | /**
482 | * Loads the properly localized PO/MO files
483 | *
484 | * @since 1.0.0
485 | */
486 | public function load_textdomain() {
487 | // Set filter for plugin's languages directory
488 | $segment_lang_dir = dirname( plugin_basename( __FILE__ ) ) . '/languages/';
489 | $segment_lang_dir = apply_filters( 'segment_languages_directory', $segment_lang_dir );
490 |
491 | // Traditional WordPress plugin locale filter
492 | $locale = apply_filters( 'plugin_locale', get_locale(), 'segment' );
493 | $mofile = sprintf( '%1$s-%2$s.mo', 'segment', $locale );
494 |
495 | // Setup paths to current locale file
496 | $mofile_local = $segment_lang_dir . $mofile;
497 | $mofile_global = WP_LANG_DIR . '/segment/' . $mofile;
498 |
499 | if ( file_exists( $mofile_global ) ) {
500 | // Look in global /wp-content/languages/segment folder
501 | load_textdomain( 'segment', $mofile_global );
502 | } elseif ( file_exists( $mofile_local ) ) {
503 | // Look in local /wp-content/plugins/analytics-wordpress/languages/ folder
504 | load_textdomain( 'segment', $mofile_local );
505 | } else {
506 | // Load the default language files
507 | load_plugin_textdomain( 'segment', false, $segment_lang_dir );
508 | }
509 | }
510 |
511 | /**
512 | * Outputs analytics javascript and analytics.identify() snippet in head for admin, login page and wp_head.
513 | *
514 | * @since 1.0.0
515 | */
516 | public function wp_head() {
517 |
518 | // Figure out whether the user should be ignored or not.
519 | $ignore = false;
520 |
521 | $settings = $this->get_settings();
522 | $user = wp_get_current_user();
523 |
524 | if ( $user->user_level >= $settings['ignore_user_level'] ) {
525 | $ignore = true;
526 | }
527 |
528 | // Render the snippet.
529 | self::$instance->analytics->initialize( $settings, $ignore );
530 | }
531 |
532 | /**
533 | * Outputs analytics.track()/.page()/ snippet in head for admin, login page and wp_footer.
534 | *
535 | * @since 1.0.0
536 | */
537 | public function wp_footer() {
538 |
539 | // Identify the user if the current user merits it.
540 | $identify = $this->get_current_user_identify();
541 |
542 |
543 | if ( $identify ) {
544 |
545 | if ( ! isset( $identify['options'] ) ) {
546 | $identify['options'] = array();
547 | }
548 |
549 | self::$instance->analytics->identify( $identify['user_id'], $identify['traits'], $identify['options'] );
550 | }
551 |
552 | // Track a custom page view event if the current page merits it.
553 | $track = $this->get_current_page_track();
554 | $page = $this->get_current_page();
555 |
556 | if ( $track ) {
557 | $http_event = isset( $track['http_event'] ) ? $track['http_event'] : false;
558 | self::$instance->analytics->track( $track['event'], $track['properties'], array(), $http_event );
559 | }
560 |
561 | if ( $page ) {
562 | self::$instance->analytics->page( $page['page'], $page['properties'] );
563 | }
564 | }
565 |
566 | /**
567 | * Uses Segment_Cookie::set_cookie() to notify Segment that a comment has been left.
568 | *
569 | * @param int $id Comment ID. Unused.
570 | * @param object $comment WP_Comment object Unused.
571 | *
572 | * @since 1.0.0
573 | */
574 | public function insert_comment( $id, $comment ) {
575 |
576 | Segment_Cookie::set_cookie( 'left_comment', md5( json_encode( wp_get_current_commenter() ) ) );
577 | }
578 |
579 | /**
580 | * Uses Segment_Cookie::set_cookie() to notify Segment that a user has logged in.
581 | *
582 | * @since 1.0.0
583 | *
584 | * @param string $login Username of logged in user.
585 | * @param WP_User $user User object of logged in user.
586 | *
587 | */
588 | public function login_event( $login, $user ) {
589 |
590 | Segment_Cookie::set_cookie( 'logged_in', md5( json_encode( $user ) ) );
591 | }
592 |
593 | /**
594 | * Uses Segment_Cookie::set_cookie() to notify Segment that a user has signed up.
595 | *
596 | * @since 1.0.0
597 | *
598 | * @param int $user_id Username of new user.
599 | *
600 | */
601 | public function user_register( $user_id ) {
602 |
603 | Segment_Cookie::set_cookie( 'signed_up', json_encode( $user_id ) );
604 | }
605 |
606 | /**
607 | * Adds "Settings" link to plugin row.
608 | *
609 | * @param array $links Array of links on plugin action row.
610 | * @param string $file Basename of file.
611 | * @return array $links Modified array of links on plugin action row.
612 | */
613 | public function plugin_action_links( $links, $file ) {
614 |
615 | // Not for other plugins, silly. NOTE: This doesn't work properly when
616 | // the plugin for testing is a symlink!! If you change this, test it.
617 | // Note: Works fine as of 3.9, see @link: https://core.trac.wordpress.org/ticket/16953
618 | if ( $file != plugin_basename( __FILE__ ) ) {
619 | return $links;
620 | }
621 |
622 | // Add settings link to the beginning of the row of links.
623 | $settings_link = sprintf( '%s', __( 'Settings' ) );
624 |
625 | array_unshift( $links, $settings_link );
626 |
627 | return $links;
628 | }
629 |
630 | /**
631 | * Adds Settings and Documentation links to plugin row meta.
632 | *
633 | * @since 1.0.0
634 | *
635 | * @param array $plugin_meta An array of the plugin's metadata,
636 | * including the version, author,
637 | * author URI, and plugin URI.
638 | * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
639 | *
640 | * @return array Modified array of plugin metadata.
641 | */
642 | public function plugin_row_meta( $plugin_meta, $plugin_file ) {
643 | // Not for other plugins, silly. NOTE: This doesn't work properly when
644 | // the plugin for testing is a symlink!! If you change this, test it.
645 | // Note: Works fine as of 3.9, see @link: https://core.trac.wordpress.org/ticket/16953
646 | if ( $plugin_file != plugin_basename( __FILE__ ) ) {
647 | return $plugin_meta;
648 | }
649 |
650 | // Add a settings and docs link to the end of the row of links row of links.
651 | $settings_link = sprintf( '%s', __( 'Settings' ) );
652 | $docs_link = sprintf( '%s', __( 'Docs', 'segment' ) );
653 |
654 | array_push( $plugin_meta, $settings_link, $docs_link );
655 |
656 | return $plugin_meta;
657 | }
658 |
659 | /**
660 | * Adds "Analytics" Menu item to admin area.
661 | *
662 | * @since 1.0.0
663 | */
664 | public function admin_menu() {
665 |
666 | add_options_page(
667 | apply_filters( 'segment_admin_menu_page_title', __( 'Analytics', 'segment' ) ), // Page Title
668 | apply_filters( 'segment_admin_menu_menu_title', __( 'Analytics', 'segment' ) ), // Menu Title
669 | apply_filters( 'segment_admin_settings_capability', 'manage_options' ), // Capability Required
670 | self::SLUG, // Menu Slug
671 | array( $this, 'admin_page' ) // Function
672 | );
673 |
674 | }
675 |
676 | /**
677 | * The callback used to build out the admin settings area.
678 | *
679 | * @since 1.0.0
680 | */
681 | public function admin_page() {
682 |
683 | // Make sure the user has the required permissions to view the settings.
684 | if ( ! current_user_can( 'manage_options' ) ) {
685 | wp_die( __( 'Sorry, you don\'t have the permissions to access this page.', 'segment' ) );
686 | }
687 |
688 | include_once( SEG_FILE_PATH . '/templates/settings.php');
689 | }
690 |
691 | /**
692 | * Retrieves settings array.
693 | *
694 | * @since 1.0.0
695 | *
696 | * @uses apply_filters() Applies 'segment_get_settings' filter to allow other developers to override.
697 | *
698 | * @return array Array of settings.
699 | */
700 | public function get_settings() {
701 | return apply_filters( 'segment_get_settings', get_option( $this->option ), $this );
702 | }
703 |
704 | /**
705 | * Updates settings array.
706 | *
707 | * @since 1.0.0
708 | *
709 | * @param array $settings Array of settings
710 | * @uses apply_filters() Applies 'segment_get_settings' filter to allow other developers to override.
711 | *
712 | * @deprecated Deprecated in 1.0.0
713 | *
714 | * @return array Array of settings.
715 | */
716 | private function set_settings( $settings ) {
717 | return update_option( $this->option, $settings );
718 | }
719 |
720 | /**
721 | * Based on the current user or commenter, see if we have enough information
722 | * to record an `identify` call. Since commenters don't have IDs, we
723 | * identify everyone by their email address.
724 | *
725 | * @since 1.0.0
726 | *
727 | * @return bool|array Returns false if there is no commenter or logged in user
728 | * An array of the user ID and traits if there is an authenticated user.
729 | */
730 | public function get_current_user_identify() {
731 | $settings = $this->get_settings();
732 |
733 | $user = wp_get_current_user();
734 | $commenter = array_filter( wp_get_current_commenter() );
735 | $identify = false;
736 |
737 | // We've got a logged-in user.
738 | // http://codex.wordpress.org/Function_Reference/wp_get_current_user
739 | if ( is_user_logged_in() && $user ) {
740 | $identify = array(
741 | 'user_id' => $user->user_email,
742 | 'traits' => array(
743 | 'username' => $user->user_login,
744 | 'email' => $user->user_email,
745 | 'firstName' => $user->user_firstname,
746 | 'lastName' => $user->user_lastname,
747 | 'url' => $user->user_url
748 | )
749 | );
750 | }
751 | // We've got a commenter.
752 | // http://codex.wordpress.org/Function_Reference/wp_get_current_commenter
753 | else if ( $commenter ) {
754 | $identify = array(
755 | 'user_id' => $commenter['comment_author_email'],
756 | 'traits' => array(
757 | 'email' => $commenter['comment_author_email'],
758 | 'name' => $commenter['comment_author'],
759 | 'url' => $commenter['comment_author_url']
760 | )
761 | );
762 | }
763 |
764 | if ( $identify ) {
765 | // Clean out empty traits before sending it back.
766 | $identify['traits'] = array_filter( $identify['traits'] );
767 | }
768 |
769 | /**
770 | * Allows developers to modify the entire $identify call.
771 | *
772 | * @since 1.0.0
773 | */
774 | return apply_filters( 'segment_get_current_user_identify', $identify, $settings, $this );
775 | }
776 |
777 | /**
778 | * Used to track the current event. Used for analytics.track().
779 | *
780 | * @since 1.0.0
781 | *
782 | * @return array Array containing the page being tracked along with any additional properties.
783 | */
784 | private function get_current_page_track() {
785 |
786 | $settings = $this->get_settings();
787 |
788 | // Login Event
789 | // --------
790 | if ( $settings['track_logins'] ) {
791 |
792 | $user = wp_get_current_user();
793 | $hash = md5( json_encode( $user ) );
794 |
795 | if ( Segment_Cookie::get_cookie( 'logged_in', $hash ) ) {
796 |
797 | $track = array(
798 | 'event' => __( 'Logged In', 'segment' ),
799 | 'properties' => array(
800 | 'username' => $user->user_login,
801 | 'email' => $user->user_email,
802 | 'name' => $user->display_name,
803 | 'firstName' => $user->user_firstname,
804 | 'lastName' => $user->user_lastname,
805 | 'url' => $user->user_url
806 | ),
807 | 'http_event' => 'logged_in'
808 | );
809 |
810 | }
811 |
812 | }
813 |
814 | // Posts
815 | // -----
816 | if ( $settings['track_posts'] ) {
817 | // A post or a custom post. `is_single` also returns attachments, so
818 | // we filter those out. The event name is based on the post's type,
819 | // and is uppercased.
820 | if ( is_single() && ! is_attachment() ) {
821 |
822 | if ( ! self::is_excluded_post_type() ) {
823 | $categories = implode( ', ', wp_list_pluck( get_the_category( get_the_ID() ), 'name' ) );
824 | $track = array(
825 | 'event' => sprintf( __( 'Viewed %s', 'segment' ), ucfirst( get_post_type() ) ),
826 | 'properties' => array(
827 | 'title' => single_post_title( '', false ),
828 | 'category' => $categories
829 | )
830 | );
831 | }
832 |
833 | }
834 | }
835 |
836 | // Pages
837 | // -----
838 | if ( $settings['track_pages'] ) {
839 | // The front page of their site, whether it's a page or a list of
840 | // recent blog entries. `is_home` only works if it's not a page,
841 | // that's why we don't use it.
842 | if ( is_front_page() ) {
843 | $track = array(
844 | 'event' => __( 'Viewed Home Page', 'segment' )
845 | );
846 | }
847 | // A normal WordPress page.
848 | else if ( is_page() ) {
849 | $track = array(
850 | 'event' => sprintf( __( 'Viewed %s Page', 'segment' ), single_post_title( '', false ) ),
851 | );
852 | }
853 | }
854 |
855 | // Archives
856 | // --------
857 | if ( $settings['track_archives'] ) {
858 | // An author archive page. Check the `wp_title` docs to see how they
859 | // get the title of the page, cuz it's weird.
860 | // http://core.trac.wordpress.org/browser/tags/3.5.1/wp-includes/general-template.php#L0
861 | if ( is_author() ) {
862 | $author = get_queried_object();
863 | $track = array(
864 | 'event' => __( 'Viewed Author Page', 'segment' ),
865 | 'properties' => array(
866 | 'author' => $author->display_name
867 | )
868 | );
869 | }
870 | // A tag archive page. Use `single_tag_title` to get the name.
871 | // http://codex.wordpress.org/Function_Reference/single_tag_title
872 | else if ( is_tag() ) {
873 | $track = array(
874 | 'event' => __( 'Viewed Tag Page', 'segment' ),
875 | 'properties' => array(
876 | ' tag' => single_tag_title( '', false )
877 | )
878 | );
879 | }
880 | // A category archive page. Use `single_cat_title` to get the name.
881 | // http://codex.wordpress.org/Function_Reference/single_cat_title
882 | else if ( is_category() ) {
883 | $track = array(
884 | 'event' => __( 'Viewed Category Page', 'segment' ),
885 | 'properties' => array(
886 | 'category' => single_cat_title( '', false )
887 | )
888 | );
889 | }
890 | }
891 |
892 | // Comments
893 | // --------
894 | if ( $settings['track_comments'] ) {
895 |
896 | $commenter = array_filter( wp_get_current_commenter() );
897 |
898 | if ( $commenter ) {
899 | $hash = md5( json_encode( $commenter ) );
900 |
901 | if ( Segment_Cookie::get_cookie( 'left_comment', $hash ) ) {
902 |
903 | $track = array(
904 | 'event' => __( 'Commented', 'segment' ),
905 | 'properties' => array(
906 | 'commenter' => $commenter
907 | ),
908 | 'http_event' => 'left_comment'
909 | );
910 | }
911 | }
912 |
913 | }
914 |
915 | // Login Page
916 | // --------
917 | if ( $settings['track_login_page'] ) {
918 |
919 | if ( did_action( 'login_init' ) ) {
920 |
921 | $track = array(
922 | 'event' => __( 'Viewed Login Page', 'segment' )
923 | );
924 |
925 | }
926 |
927 | }
928 |
929 | // Searches
930 | // --------
931 | if ( $settings['track_searches'] ) {
932 | // The search page.
933 | if ( is_search() ) {
934 | $track = array(
935 | 'event' => __( 'Viewed Search Page', 'segment' ),
936 | 'properties' => array(
937 | 'query' => get_query_var( 's' )
938 | )
939 | );
940 | }
941 | }
942 |
943 | if ( Segment_Cookie::get_cookie( 'signed_up' ) ) {
944 |
945 | $user_id = json_decode( Segment_Cookie::get_cookie( 'signed_up' ) );
946 | $user = get_user_by( 'id', $user_id );
947 |
948 | add_filter( 'segment_get_current_user_identify', array( self::$instance, 'new_user_identify' ) );
949 |
950 | $track = array(
951 | 'event' => __( 'User Signed Up', 'segment' ),
952 | 'properties' => array(
953 | 'username' => $user->user_login,
954 | 'email' => $user->user_email,
955 | 'name' => $user->display_name,
956 | 'firstName' => $user->user_firstname,
957 | 'lastName' => $user->user_lastname,
958 | 'url' => $user->user_url
959 | ),
960 | 'http_event' => 'signed_up'
961 | );
962 |
963 | }
964 |
965 | // We don't have a page we want to track.
966 | if ( ! isset( $track ) ) {
967 | $track = false;
968 | }
969 |
970 | if ( $track ) {
971 | // All of these are checking for pages, and we don't want that to throw
972 | // off Google Analytics's bounce rate, so mark them `noninteraction`.
973 | $track['properties']['nonInteraction'] = true;
974 |
975 | // Clean out empty properties before sending it back.
976 | $track['properties'] = array_filter( $track['properties'] );
977 | }
978 |
979 | return apply_filters( 'segment_get_current_page_track', $track, $settings, $this );
980 | }
981 |
982 | /**
983 | * Filters the .identify() call with the newly signed up user.
984 | * This is helpful, as the user will often times not be authenticated after signing up.
985 | *
986 | * @since 1.0.0
987 | *
988 | * @param mixed $identify False if no user is found, array of traits and ID if a user is found.
989 | * @return array $identify Array of traits for newly signed up user.
990 | */
991 | public function new_user_identify( $identify ) {
992 |
993 | if ( Segment_Cookie::get_cookie( 'signed_up' ) ) {
994 |
995 | $user_id = json_decode( Segment_Cookie::get_cookie( 'signed_up' ) );
996 | $user = get_user_by( 'id', $user_id );
997 |
998 | $identify = array(
999 | 'user_id' => $user->user_email,
1000 | 'traits' => array(
1001 | 'username' => $user->user_login,
1002 | 'email' => $user->user_email,
1003 | 'firstName' => $user->user_firstname,
1004 | 'lastName' => $user->user_lastname,
1005 | 'url' => $user->user_url
1006 | )
1007 | );
1008 | }
1009 |
1010 | return $identify;
1011 | }
1012 |
1013 | /**
1014 | * Used to track the current page. Used for analytics.page().
1015 | * Unlike get_current_page_track(), we use this primarily as a pub-sub observer for other core events.
1016 | * This makes it much more manageable for other developers to hook and unhook from it as needed.
1017 | *
1018 | * @since 1.0.0
1019 | *
1020 | * @return array Array containing the page being tracked along with any additional properties.
1021 | */
1022 | private function get_current_page() {
1023 |
1024 | $page = apply_filters( 'segment_get_current_page', false, $this->get_settings(), $this );
1025 |
1026 | if ( $page ) {
1027 | $page['properties'] = is_array( $page['properties'] ) ? $page['properties'] : array();
1028 | // All of these are checking for pages, and we don't want that to throw
1029 | // off Google Analytics's bounce rate, so mark them `noninteraction`.
1030 | $page['properties']['nonInteraction'] = true;
1031 |
1032 | // Clean out empty properties before sending it back.
1033 | $page['properties'] = array_filter( $page['properties'] );
1034 | }
1035 |
1036 | return $page;
1037 | }
1038 |
1039 | /**
1040 | * Kept for backwards compatibility, as clean_array() used to be, essentially, a round-about to array_filter().
1041 | *
1042 | * @since 1.0.0
1043 | *
1044 | * @deprecated
1045 | *
1046 | * @param array $array Array to clean.
1047 | * @return array Filtered array.
1048 | */
1049 | private function clean_array( $array ) {
1050 | return array_filter( $array );
1051 | }
1052 |
1053 | /**
1054 | * Used in our activation hook to set up our default settings.
1055 | *
1056 | * @since 1.0.0
1057 | *
1058 | * @return void
1059 | */
1060 | public static function setup_settings() {
1061 |
1062 | $settings = get_option( Segment_Analytics_WordPress::get_instance()->get_option_name() );
1063 |
1064 | if ( ! empty( $settings ) ) {
1065 | return;
1066 | }
1067 |
1068 | update_option( Segment_Analytics_WordPress::get_instance()->get_option_name(), Segment_Analytics_WordPress::get_instance()->defaults );
1069 | }
1070 |
1071 | /**
1072 | * Helper function, essentially a replica of stripslashes_deep, but for esc_js.
1073 | *
1074 | * @since 1.0.0
1075 | *
1076 | * @param mixed $value Handles arrays, strings and objects that we are trying to escape for JS.
1077 | * @return mixed $value esc_js()'d value.
1078 | */
1079 | public static function esc_js_deep( $value ) {
1080 | if ( is_array( $value ) ) {
1081 | $value = array_map( array( __CLASS__, 'esc_js_deep' ), $value );
1082 | } elseif ( is_object( $value ) ) {
1083 | $vars = get_object_vars( $value );
1084 | foreach ( $vars as $key => $data ) {
1085 | $value->{$key} = self::esc_js_deep( $data );
1086 | }
1087 | } elseif ( is_string( $value ) ) {
1088 | $value = esc_js( $value );
1089 | }
1090 |
1091 | return $value;
1092 | }
1093 |
1094 | /**
1095 | * Checks if current post type is excluded or not.
1096 | * Intended to be used on singular views.
1097 | *
1098 | * @since 1.0.0
1099 | *
1100 | * @return boolean Whether or not post type is excluded
1101 | */
1102 | public static function is_excluded_post_type() {
1103 | $settings = self::get_instance()->get_settings();
1104 |
1105 | $cpts = isset( $settings['exclude_custom_post_types'] ) ? $settings['exclude_custom_post_types'] : array();
1106 |
1107 | return in_array( get_post_type(), $cpts );
1108 | }
1109 |
1110 | }
1111 |
1112 | register_activation_hook( __FILE__, array( 'Segment_Analytics_WordPress', 'setup_settings' ) );
1113 | add_action( 'plugins_loaded', 'Segment_Analytics_WordPress::get_instance' );
1114 |
--------------------------------------------------------------------------------