Plugin / Ad Code Manager

Rinat Khaziev, Jeremy Felt, Daniel Bachhuber, Automattic, doejo



Ad Code Manager gives non-developers an interface in the WordPress admin for configuring your complex set of ad codes.

Some code-level configuration may be necessary to setup Ad Code Manager. Ad tags must be added (via do_action()) to your theme’s template files where you’d like ads to appear. Alternatively, you can incorporate ad tags into your website with our widget and our shortcode. Check out the configuration guide for the full details.

A common set of parameters must also be defined for your ad provider. This includes the tag IDs used by your template, the default URL for your ad provider, and the default HTML surrounding that URL. Ad Code Manager comes with support for Google Doubleclick For Publishers (and Async), and Google AdSense. All of the logic is abstracted, however, so configuring a different provider is relatively easy. Check providers/doubleclick-for-publishers.php for an idea of how to extend ACM to suit your needs.

Once this configuration is in place, the Ad Code Manager admin interface will allow you to add new ad codes, modify the parameters for your script URL, and define conditionals to determine when the ad code appears. Conditionals are core WordPress functions like is_page(), is_category(), or your own custom functions that evaluate certain expression and then return true or false.

Fork the plugin on Github and follow our development blog.

Configuration Filters

There are some filters which allow you to easily customize the output of the plugin. You should place these filters in your theme’s functions.php file or in another appropriate place.

Check out this gist to see all of the filters in action.


Ad tag ids are used as a parameter when adding tags to your theme (e.g. do_action( ‘acm_tag’, ‘my_top_leaderboard’ )). The url_vars defined as part of each tag here will also be used to replace tokens in your default URL.

* array $tag_ids array of default tag ids

Example usage: Add a new ad tag called ‘my_top_leaderboard’

    add_filter( 'acm_ad_tag_ids', 'my_acm_ad_tag_ids' );
        function my_acm_ad_tag_ids( $tag_ids ) {
            $tag_ids[] = array(
                'tag' => 'my_top_leaderboard', // tag_id
                'url_vars' => array(
                    'sz' => '728x90', // %sz% token
                    'fold' => 'atf', // %fold% token
                    'my_custom_token' => 'something' // %my_custom_token% will be replaced with 'something'
            return $tag_ids;


Set the default tokenized URL used when displaying your ad tags. This filter is required.

* string $url The tokenized url of Ad Code

Example usage: Set your default ad code URL

    add_filter( 'acm_default_url', 'my_acm_default_url' );
        function my_acm_default_url( $url ) {
            if ( 0 === strlen( $url )  ) {
                return ";s1=%zone1%;s2=;pid=%permalink%;fold=%fold%;kw=;test=%test%;ltv=ad;pos=%pos%;dcopt=%dcopt%;tile=%tile%;sz=%sz%;";


The HTML outputted by the do_action( 'acm_tag', 'ad_tag_id' ); call in your theme. Support multiple ad formats ( e.g. Javascript ad tags, or simple HTML tags ) by adjusting the HTML rendered for a given ad tag.

The %url% token used in this HTML will be filled in with the URL defined with acm_default_url.

* string $output_html The original output HTML
* string $tag_id Ad tag currently being accessed

Example usage:

    add_filter( 'acm_output_html', 'my_acm_output_html', 10, 2 );
        function my_acm_output_html( $output_html, $tag_id ) {
            switch ( $tag_id ) {
                case 'my_leaderboard':
                    $output_html = '<a href="%url%"><img src="%image_url%" /></a>';
                case 'rich_media_leaderboard':
                    $output_html = '<script> // omitted </script>';
            return $output_html;


Ad Code Manager has a built in list of providers that it gathers by scanning the ‘providers’ directory used by the plugin. Additional providers can be added by placing the appropriate files in that directory, or by using the acm_register_provider_slug filter to register those that may be included as part of your theme or another plugin.

When using this plugin, you are defining the provider slug as part of the existing object as well as an array of classes associated with that provider slug.

* object $providers An object containing the current registered providers.

Example usage:

    add_filter( 'acm_register_provider_slug', 'my_acm_register_provider_slug' );
        function my_acm_register_provider_slug( $providers ) {
            $providers->new_provider_slug = array(
                'provider' => 'My_New_Ad_Company_ACM_Provider',
                'table' => 'My_New_Ad_Company_ACM_WP_List_Table'
            return $providers;


A security filter to whitelist which ad code script URLs can be added in the admin

* array $whitelisted_urls Existing whitelisted ad code URLs

Example usage: Allow Doubleclick for Publishers ad codes to be used

    add_filter( 'acm_whitelisted_script_urls', 'my_acm_whitelisted_script_urls' );
        function my_acm_whiltelisted_script_urls( $whitelisted_urls ) {
            $whitelisted_urls = array( '' );
            return $whitelisted_urls;


Output tokens can be registered depending on the needs of your setup. Tokens defined here will be replaced in the ad tag’s tokenized URL in addition to the tokens already registered with your tag id.

* array $output_tokens Any existing output tokens
* string $tag_id Unique tag id
* array $code_to_display Ad Code that matched conditionals

Example usage: Test to determine whether you’re in test or production by passing ?test=on query argument

    add_filter( 'acm_output_tokens', 'my_acm_output_tokens', 10, 3 );
        function my_acm_output_tokens( $output_tokens, $tag_id, $code_to_display ) {
            $output_tokens['%test%'] = isset( $_GET['test'] ) && $_GET['test'] == 'on' ? 'on' : '';
            return $output_tokens;


Extend the list of usable conditional functions with your own awesome ones. We whitelist these so users can’t execute random PHP functions.

* array $conditionals Default conditionals

Example usage: Register a few custom conditional callbacks

    add_filter( 'acm_whitelisted_conditionals', 'my_acm_whitelisted_conditionals' );
        function my_acm_whitelisted_conditionals( $conditionals ) {
            $conditionals[] = 'my_is_post_type';
            $conditionals[] = 'is_post_type_archive';
            $conditionals[] = 'my_page_is_child_of';
            return $conditionals;


For certain conditionals (has_tag, has_category), you might need to pass additional arguments.

* array $cond_args Existing conditional arguments
* string $cond_func Conditional function (is_category, is_page, etc)

Example usage: has_category() and has_tag() use has_term(), which requires the object ID to function properly

    add_filter( 'acm_conditional_args', 'my_acm_conditional_args', 10, 2 );
        function my_acm_conditional_args( $cond_args, $cond_func ) {
            global $wp_query;
            // has_category and has_tag use has_term
            // we should pass queried object id for it to produce correct result
            if ( in_array( $cond_func, array( 'has_category', 'has_tag' ) ) ) {
                if ( $wp_query->is_single == true ) {
                    $cond_args[] = $wp_query->queried_object->ID;
            // my_page_is_child_of is our custom WP conditional tag and we have to pass queried object ID to it
            if ( in_array( $cond_func, array( 'my_page_is_child_of' ) ) && $wp_query->is_page ) {
                $cond_args[] = $cond_args[] = $wp_query->queried_object->ID;

            return $cond_args;


Change the behavior of Ad Code Manager so that ad codes without conditionals display on the frontend. The default behavior is that each ad code requires a conditional to be included in the presentation logic.

* bool $behavior Whether or not to display the ad codes that don’t have conditionals

Example usage:

    add_filter( 'acm_display_ad_codes_without_conditionals', '__return_true' );


By default we use our bundled doubleclick_for_publishers config ( check it in /providers/doubleclick-for-publishers.php ). If you want to add your own flavor of DFP or even implement configuration for some another ad network, you’d have to apply a filter to correct the slug.

Example usage:

    add_filter( 'acm_provider_slug', function() { return 'my-ad-network-slug'; } );


By default logical operator is set to “OR”, that is, ad code will be displayed if at least one conditional returns true.
You can change it to “AND”, so that ad code will be displayed only if ALL of the conditionals match

Example usage:

    add_filter( 'acm_logical_operator', function() { return 'AND'; } );


By default user has to have “manage_options” cap. This filter comes in handy, if you want to relax the requirements.

Example usage:

    add_filter( 'acm_manage_ads_cap', function( $cap ) { return 'edit_others_posts'; } );


This filter is only for edge cases. Most likely you won’t have to touch it. Allows to include additional query args for Ad_Code_Manager->get_ad_codes() method.

Example usage:

    add_filter( 'acm_allowed_get_posts_args', function( $args_array ) { return array( 'offset', 'exclude' ); } );


By default the total number of ad codes to get is 50, which is reasonable for any small to mid site. However, in some certain cases you would want to increase the limit. This will affect Ad_Code_Manager->get_ad_codes() ‘numberposts’ query argument.

Example usage:

    add_filter( 'acm_ad_code_count', function( $total ) { return 100; } );


This filter can alter table columns that are displayed in ACM UI.

Example usage:

    add_filter( 'acm_list_table_columns', 'my_acm_list_table_columns' );
        function my_acm_list_table_columns( $columns ) {
            $columns = array(
                'id'             => __( 'ID', 'ad-code-manager' ),
                'name'           => __( 'Name', 'ad-code-manager' ),
                'priority'       => __( 'Priority', 'ad-code-manager' ),
                'conditionals'   => __( 'Conditionals', 'ad-code-manager' ),
            return $columns;


This filter comes in pair with previous one, it should return array of ad network specific parameters. E.g. in acm_list_table_columns example we have
‘id’, ‘name’, ‘priority’, ‘conditionals’. All of them except name are generic for Ad Code Manager. Hence acm_provider_columns should return only “name”. “editable” and “required” indicate whether this field should be editable and required.

Example usage:

    add_filter( 'acm_ad_code_args', 'my_acm_ad_code_args' );
        function my_acm_ad_code_args( $args ) {
            $args = array(
                    'key'       => 'name',
                    'label'     => __( 'Name', 'ad-code-manager' ),
                    'editable'  => true,
                    'required'  => true,
            return $args;


0 reviews

Rating breakdown

Details Information



First Released

18 Jan, 2012

Total Downloads


Wordpress Version

3.1 or higher

Tested up to:


Require PHP Version:





The plugin hasn't been transalated in any language other than English.


The information provided in this THEME/PLUGIN DIRECTORY is made available for information purposes only, and intended to serve as a resource to enable visitors to select a relevant theme or plugin. wpSocket gives no warranty of any kind, express or implied with regard to the information, including without limitation any warranty that the particular theme or plugin that you select is qualified on your situation.

The information in the individual theme or plugin displayed in the Directory is provided by the owners and contributors themselves. wpSocket gives no warranty as to the accuracy of the information and will not be liable to you for any loss or damage suffered by you as a consequence of your reliance on the information.

Links to respective sites are offered to assist in accessing additional information. The links may be outdated or broken. Connect to outside sites at your own risk. The Theme/Plugin Directory does not endorse the content or accuracy of any listing or external website.

While information is made available, no guarantee is given that the details provided are correct, complete or up-to-date.

wpSocket is not related to the theme or plugin, and also not responsible and expressly disclaims all liability for, damages of any kind, arising out of the use, reference to, or reliance on, any information or business listed throughout our site.

Keep Leading Your Followers!
Share it for them.