defineAdminPage(); AddPluginSettingsLink::register(); } } public function onActivation(): void { $this->addOptions(); } public function onUninstall(): void { $this->deleteOptions(); } public function onInit(): void { $shouldCollect = (new TrackingPolicy)->shouldCollectAnalytics(); $this->addScripts($shouldCollect); if (! $shouldCollect) { AddInactiveComment::register(); } if ($shouldCollect && Setting::boolean(SettingName::NOSCRIPT)) { AddNoScriptTag::register(); } } /** * Register plugin options and autoload them. * * @note Eliminates any unnecessary database lookups by preloading on each request. * @note Thanks to option autoloading, we don't need to use one serialized option, but several. * This allows the usage of native hooks and filters and reduces the chance of data corruption. */ protected function addOptions(): void { // Add options with default values add_option(SettingName::ENABLED, '1', null, true); // Add all remaining options $optionNames = array_diff(SettingName::cases(), [SettingName::ENABLED]); foreach ($optionNames as $name) { add_option($name, null, null, true); } // Legacy. Update the option introduced in a previous release to use autoloading. update_option(SettingName::CUSTOM_DOMAIN, get_option(SettingName::CUSTOM_DOMAIN), true); } protected function deleteOptions(): void { foreach (SettingName::cases() as $name) { delete_option($name); } } protected function addScripts(bool $collect): void { $scripts = new ScriptManager; if ($collect) { $scripts->add(new AnalyticsScript); } elseif (is_user_logged_in()) { $scripts->add(new InactiveScript); } if (Setting::boolean(SettingName::AUTOMATED_EVENTS)) { $scripts->add(new AutomatedEventsScript); } $scripts->register(); } protected function defineAdminPage(): void { Page::title('Simple Analytics') ->slug('simpleanalytics') ->tab('General', function (Tab $tab) { $tab->input(SettingName::CUSTOM_DOMAIN, 'Custom Domain') ->placeholder('Enter your custom domain or leave it empty.') ->description('E.g. api.example.com. Leave empty to use the default domain (most users).') ->docs('https://docs.simpleanalytics.com/bypass-ad-blockers'); }) ->tab('Ignore Rules', function (Tab $tab) { $tab->icon(get_icon('eye-slash')); $tab->input(SettingName::IGNORE_PAGES, 'Ignore Pages') ->description('Comma separated list of pages to ignore. E.g. /contact, /about') ->placeholder('Example: /page1, /page2, /category/*') ->docs('https://docs.simpleanalytics.com/ignore-pages'); $tab->callout('IP and role exclusion only works when there is no page caching.'); $tab->multiCheckbox(SettingName::EXCLUDED_ROLES, 'Exclude User Roles') ->options(function () { return wp_roles()->get_names(); }); $tab->ipList(SettingName::EXCLUDED_IP_ADDRESSES, 'Exclude IP Addresses') ->placeholder("127.0.0.1\n192.168.0.1") ->description('IP addresses to exclude from tracking.'); }) ->tab('Advanced', function (Tab $tab) { $tab->icon(get_icon('cog')); $tab->checkbox(SettingName::COLLECT_DNT, 'Collect Do Not Track') ->description('If you want to collect visitors with Do Not Track enabled, turn this on.') ->docs('https://docs.simpleanalytics.com/dnt'); $tab->checkbox(SettingName::HASH_MODE, 'Hash mode') ->description('If your website uses hash (#) navigation, turn this on. On most WordPress websites this is not relevant.') ->docs('https://docs.simpleanalytics.com/hash-mode'); $tab->checkbox(SettingName::MANUAL_COLLECT, 'Manually collect page views') ->description('In case you don’t want to auto collect page views, but via `sa_pageview` function in JavaScript.') ->docs('https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway'); $tab->checkbox(SettingName::NOSCRIPT, 'Support no JavaScript mode') ->description('Collect analytics from visitors with disabled or no JavaScript.'); $tab->input(SettingName::ONLOAD_CALLBACK, 'Onload Callback') ->description('JavaScript function to call when the script is loaded.') ->placeholder('Example: sa_event("My event")') ->docs('https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway'); $tab->input(SettingName::HOSTNAME, 'Overwrite domain name') ->description('Override the domain that is sent to Simple Analytics. Useful for multi-domain setups.') ->placeholder('Example: example.com') ->docs('https://docs.simpleanalytics.com/overwrite-domain-name'); $tab->input(SettingName::SA_GLOBAL, 'Global variable name') ->description('Change the global variable name of Simple Analytics. Default is `sa_event`.') ->placeholder('Example: ba_event') ->docs('https://docs.simpleanalytics.com/events#the-variable-sa_event-is-already-used'); }) ->tab('Events', function (Tab $tab) { $tab->title('Automated events') ->icon(get_icon('events')) ->description("It will track outbound links, email addresses clicks, and amount of downloads for common files (pdf, csv, docx, xIsx). Events will appear on your events page on simpleanalytics.com"); $tab->checkbox(SettingName::AUTOMATED_EVENTS, 'Collect automated events'); $tab->input(SettingName::EVENT_COLLECT_DOWNLOADS, 'Auto collect downloads') ->placeholder('Example: outbound,emails,downloads') ->docs('https://docs.simpleanalytics.com/automated-events'); $tab->input(SettingName::EVENT_EXTENSIONS, 'Download file extensions') ->description('Comma separated list of file extensions to track as downloads. E.g. pdf, zip') ->placeholder('Example: pdf, zip') ->docs('https://docs.simpleanalytics.com/automated-events'); $tab->checkbox(SettingName::EVENT_USE_TITLE, 'Use titles of page') ->description('Use the title of the page as the event name. Default is the URL.') ->docs('https://docs.simpleanalytics.com/automated-events'); $tab->checkbox(SettingName::EVENT_FULL_URLS, 'Use full URLs') ->description('Use full URLs instead of the path. Default is the path.') ->docs('https://docs.simpleanalytics.com/automated-events'); $tab->input(SettingName::EVENT_SA_GLOBAL, 'Override global') ->description('Override the global variable name of Simple Analytics. Default is `sa_event`.') ->placeholder('Example: ba_event') ->docs('https://docs.simpleanalytics.com/events#the-variable-sa_event-is-already-used'); }) ->register(); } }