Version WizePandas-PHP-1.0.0
-
Place the contents of the
/srcfolder into the new project, preferably a library or includes folder. -
On any page that you want the plugin to work, you must add the following code at the top of the PHP code and in the
<head>section of the page:
<?php require_once('path/to/src/wizepandas.php'); ?>
<!DOCTYPE html>
<html>
<head>
...
<?php echo $wizepandas->getHeadCode(); ?>
</head>
</html>
This code injection is often placed in a file that the site uses globally as in the test site provided in the /example folder (see /example/header.php) or may need to be added to a series of individual pages. As for the head code, that only needs to go somewhere within the <head> tag, but the require_once code must to appear before any code is rendered to the DOM in other words before the initial <html> tag.
- Within the
wizepandas.phpfile, put your API key for the site in the following spot:
$wizepandas_config = array(
'apiKey' => 'Your-API-Key-Here',
...
);
- Finally, on any page where ads appear, add the following code somewhere within the
<body>tag:
<?php echo $wizepandas->getBodyCode(); ?>
This code is part of our ad block detection tests. It should be at the top of the body to run as early as possible.
The wizepandas.php file provides a default implementation of the required injected code snippet persistent store. This implementation
uses a combination of sessions and simple filesystem storage. This requires that you create a writable directory
named fs on your server. Provide a jsPath option in the $wizepandas_config options to select a different location for storage of the code snippet. This path and directory must be writable by PHP code when served.
Our ad-block handling code is regularly updated in response to changes to ad-block rules, so it is best practice to retrieve the
latest version once a day. You can change the default expiry by providing a jsExpiry option (expiry in seconds). The provided implementation retrieves the latest code on the first run and stores it in the
defined location on the filesystem and also stores a copy in the $_SESSION space.
You can provide your own loadScript and saveScript functions using database, memcache, redis or other technologies by
specifying loadScript and saveScript options in the $wizepandas_config options.