Back to Help Center

City Blocks Plugin Documentation

Installation

After purchasing City Blocks Pro, on the invoice screen, click the Download City Blocks button to download the plugin zip file. Copy the License key after downloading the zip file.

If you navigate from the invoice screen before copying your license key, the license information can be found by navigating to Licenses in your account. Find your purchased plugin and click the key icon to copy your license key.

Next, in your WordPress installation, navigate to Dashboard > Plugins > Add New Plugin. Upload City Blocks Pro and activate. Next, navigate to Dashboard > Setting > City Blocks . Enter your license key in the license key field to activate the plugin.

Settings

Custom Events

Click the Custom Events tab to add a custom event. Click the Add Custom Event button to add you event name and custom parameters. When adding a custom parameter, be sure to click the Add button next to the custom parameter row before saving the custom event. Check Track Clicks to track clicks in the variation. Clicks that are tracked are clicks from validly formatted links, buttons and form elements. Check Internally Log Events to maintain an internal log of triggered custom events. Please note, internally logging events may impact page/post performance.

Using City Blocks Pro

Navigate to the editor and type /City Blocks. At least 1 Area is nested inside the City Blocks. The City Blocks settings are located in the block's inspector panel. Select a default Area in the event the area is not covered by City Blocks. Areas can be renamed by navigating the list view panel, clicking the 3 vertical dots to the right of the Area, and clicking “Rename”

Area Block Settings

Enter the zip code or city to be covered by City Blocks. Currently, only the United States is supported. To handle ambiguous cities, append the state to the target city. Ex. Oakland California or Oakland Michigan.


NOTE: City Blocks cannot guarantee coverage for your desired area. The City Blocks coverage library is updated frequently.

Logs

Click the Custom Event Logs tab to view the traffic logs of City Blocks Pro. Each entry is the post or page title where the City Blocks was used. Each entry will display the triggered custom event, along with its corresponding parameters.