true ) ) {
$classes = Util::arrayify( $classes );
$html = '
';
if ( ! $args['display'] ) {
return wp_kses_post( $html );
}
echo wp_kses_post( $html );
}
/**
* End the poststuff div.
*
* @return void
*/
protected function end_poststuff() {
$this->end_div();
}
/**
* End a div.
*
* @param array $args An array of arguments.
*
* @return void|string
*/
protected function end_div( $args = array( 'display' => true ) ) {
$html = '
';
if ( ! $args['display'] ) {
return wp_kses_post( $html );
}
echo wp_kses_post( $html );
}
/**
* Create a postbox.
*
* @param string $title Title of post box.
* @param string $content Content in post box.
* @param array $classes Classes on postbox.
*
* @return void
*/
protected function postbox( $title, $content, $classes = array() ) {
$classes = Util::arrayify( $classes );
$classes[] = 'postbox';
$classes[] = Util::ns( 'postbox' );
?>
admin_dashboard()->page();
}
/**
* Display the reports page.
*
* @return void
*/
public function reports_page() {
$this->admin_reports()->page();
}
/**
* Display the support page.
*
* @return void
*/
public function support_page() {
$this->admin_support()->page();
}
/**
* Display the settings page.
*
* @return void
*/
public function settings_page() {
$this->sf()->settings_page(
$this->settings_title(),
self::settings_admin_url(),
self::settings()
);
}
/**
* Register settings from settings array.
*
* @return void
*/
public function register_settings() {
$this->sf()->add_sections_and_settings(
$this->settings(),
$this
);
}
/**
* Sanitize input by type.
*
* @param array $input The input to sanitize.
*
* @return array
*/
private function sanitize_by_key_type( $input ) {
$output = array();
if ( $input ) {
foreach ( $input as $key => $value ) {
switch ( $key ) {
case 'render_method':
case 'adsense_account':
case 'ga_tracking_ids':
case 'rel_attributes':
case 'geo_service':
case 'maxmind_license_key':
case 'maxmind_database_update':
case 'ad_label_text':
case 'pro_license_key':
case 'disable_user_roles':
case 'consent_cookie_name':
case 'consent_cookie_value':
case 'consent_cookie_comparison':
case 'prefix':
case 'adsense_amp_ad_mode':
$type = 'str';
break;
case 'filter_priority':
case 'automatic_placement':
$type = 'int';
break;
case 'ads_txt_records':
$type = 'textarea';
break;
default:
// wo_log( 'missing type for ' . $key );
$type = 'bool';
break;
}
$output[ $key ] = WOAdmin::sanitize_by_type( $value, $type );
}
}
return $output;
}
/**
* Sanitize general group.
*
* @param array $input The input to sanitize.
*
* @return array
*/
public function sanitize_adcmdr_general( $input ) {
Maintenance::flush_css_transients();
return $this->sanitize_by_key_type( $input );
}
/**
* Sanitize admin group.
*
* @param array $input The input to sanitize.
*
* @return array
*/
public function sanitize_adcmdr_admin( $input ) {
return $this->sanitize_by_key_type( $input );
}
/**
* Sanitize tracking group.
*
* @param array $input The input to sanitize.
*
* @return array
*/
public function sanitize_adcmdr_tracking( $input ) {
return $this->sanitize_by_key_type( $input );
}
/**
* Sanitize adsense group.
*
* @param array $input The input to sanitize.
*
* @return array
*/
public function sanitize_adcmdr_adsense( $input ) {
return $this->sanitize_by_key_type( $input );
}
/**
* Sanitize privacy group.
*
* @param array $input The input to sanitize.
*
* @return array
*/
public function sanitize_adcmdr_privacy( $input ) {
return $this->sanitize_by_key_type( $input );
}
/**
* Sanitize geotargeting group.
*
* @param array $input The input to sanitize.
*
* @return array
*/
public function sanitize_adcmdr_targeting( $input ) {
return $this->sanitize_by_key_type( $input );
}
/**
* Sanitize add-on group.
*
* @param array $input The input to sanitize.
*
* @return array
*/
public function sanitize_adcmdr_addons( $input ) {
return $this->sanitize_by_key_type( $input );
}
/**
* Create an underscored key from a string.
*
* @param string $key The key to convert.
*
* @return string
*/
public function _key( $key ) {
return str_replace( '-', '_', $key );
}
/**
* Create a nonce array.
* This is not an actual nonce. This array is used for creating and checking unique nonces.
*
* @param string $action The action..
* @param string $key The key to create the nonce string from.
*
* @return array
*/
protected function nonce( $action, $key ) {
return array(
'action' => $action,
'name' => $this->nonce_string( $key ),
);
}
/**
* Create a nonce field.
*
* @param array $nonce_arr A nonce array.
* @param bool $referrer Whether to include the referrer field.
*
* @return void
*/
protected function nonce_field( $nonce_arr, $referrer = false ) {
wp_nonce_field( $nonce_arr['action'], $nonce_arr['name'], $referrer );
}
/**
* Create a string for use in your nonce.
*
* @param string $action Action name.
*
* @return string
*/
protected function nonce_string( $action ) {
return sanitize_title( Util::ns( 'n-' . $action ) );
}
/**
* Create an action string for use in your nonce.
*
* @param string $action Action name.
*
* @return string
*/
protected function action_string( $action ) {
return self::_key( sanitize_title( Util::ns( $action, '_' ) ) );
}
/**
* Authorizes actions for non-settings pages.
* Interfaces with WOAdmin to check nonce, capability, and required $_POST keys.
*
* @param mixed $action_key The action key to authorized.
* @param array $required_post Any required post keys.
* @param string|bool $capability The capability required to process this action.
*
* @return void
*/
protected function check_ajax_action( $action_key, $required_post = array(), $capability = false ) {
/**
* In some cases we may want 'manage_options' instead of the custom AdCommander::capability().
* This would be for anything in the Settings section.
*
* Other areas use the custom cap so that editors can manage ads, groups, etc., if allowed.
*/
if ( ! $capability ) {
$capability = AdCommander::capability();
}
$this->authorize_ajax_action( $this->nonce_string( $action_key ), 'security', $capability, $required_post );
}
/**
* Call back for settings section.
*
* @return void
*/
public function settings_callback_adcmdr_defaults() {
?>
info( sprintf( __( 'Consent management only partially works with server-side rendering. %1$sUpdate render settings.%2$s %3$s', 'ad-commander' ), '
', '', Doc::doc_link( 'requiring_consent', false, __( 'Learn more', 'ad-commander' ) ) ), array( 'adcmdr-metaitem__warning' ) );
}
?>
pro_license_status();
if ( $old_license && ! in_array( $status, array( 'processing', 'pending', 'deactivated' ) ) ) {
ProBridge::instance()->pro_license_deactivate( $old_license );
}
ProBridge::instance()->pro_license_reset_status( true, ( $new_license ) ? true : false );
}
}
return $new_value;
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_pro_license_key() {
$pro_bridge = ProBridge::instance();
if ( $pro_bridge->is_pro_loaded() ) {
$id = array( $this->sf()->key( 'addons' ) => 'pro_license_key' );
$current_value = $this->sf()->get( 'pro_license_key', 'addons' );
$disabled = false;
$message = null;
$clr = 'neutral';
$status = $pro_bridge->pro_license_status();
if ( $current_value || $status ) {
if ( $status === 'pending' || $status === 'processing' ) {
$message = '
' . esc_html__( 'License update is pending...', 'ad-commander' );
} elseif ( $status === 'valid' ) {
$clr = 'yes';
$message = '
' . esc_html__( 'License key active.', 'ad-commander' );
} elseif ( $status === 'expired' ) {
$clr = 'no';
/* translators: %1$s: anchor tag with URL, %2$s call to action text, %3$s: close anchor tag */
$message = '
' . sprintf( esc_html__( 'License key expired - %1$s%2$s%3$s', 'ad-commander' ), '
', esc_html__( 'Renew your license', 'ad-commander' ) . ' >', '' );
} elseif ( in_array( $status, License::no_seats_license_statuses() ) ) {
$clr = 'no';
/* translators: %1$s: anchor tag with URL, %2$s call to action text, %3$s: close anchor tag */
$message = '
' . sprintf( esc_html__( 'License has no remaining activations - %1$s%2$s%3$s', 'ad-commander' ), '
', esc_html__( 'Purchase a new license', 'ad-commander' ) . ' >', '' );
} elseif ( in_array( $status, License::invalid_license_statuses() ) ) {
$clr = 'no';
/* translators: %1$s: response code, %2$s anchor tag with URL, %3$s call to action text, %4$s: close anchor tag */
$message = '
' . sprintf( esc_html__( 'License key invalid (response code: %1$s) - %2$s%3$s%4$s', 'ad-commander' ), sanitize_text_field( $status ), '
', esc_html__( 'Purchase a license', 'ad-commander' ) . ' >', '' );
} elseif ( $status !== 'deactivated' ) {
$clr = 'no';
/* translators: %1$s: anchor tag with URL, %2$s call to action text, %3$s: close anchor tag */
$message = '
' . sprintf( esc_html__( 'An unkonwn error occurred - Please %1$s%2$s%3$s', 'ad-commander' ), '
', esc_html__( 'contact support', 'ad-commander' ) . ' >', '' );
}
$pro_bridge->enqueue_pro_license_script_data( $status );
}
$this->sf()->input( $id, $current_value, 'text', array( 'disabled' => $disabled ) );
if ( $message ) {
$this->sf()->message( '
' . $message . '' );
}
} else {
echo wp_kses_post( $this->get_addons() );
}
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_geo_service() {
$id = array( $this->sf()->key( 'targeting' ) => 'geo_service' );
$current_value = null;
$args = array(
'empty_text' => __( 'Select a service', 'ad-commander' ),
);
$options = array(
'disabled:maxmind' => __( 'MaxMind', 'ad-commander' ),
);
if ( ProBridge::instance()->is_pro_loaded() ) {
$current_value = $this->sf()->get( 'geo_service', 'targeting' );
$pro_options = array();
foreach ( $options as $key => $text ) {
$pro_options[ str_replace( 'disabled:', '', $key ) ] = $text;
}
$options = $pro_options;
} else {
$args['empty_text'] .= ProBridge::pro_label();
}
$this->sf()->select(
$id,
$options,
$current_value,
$args
);
Doc::doc_link( 'geo_targeting' );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_maxmind_license_key() {
if ( ProBridge::instance()->is_pro_loaded() ) {
$this->admin_geo()->field_maxmind_license_key();
}
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_maxmind_database_update() {
if ( ProBridge::instance()->is_pro_loaded() ) {
$this->admin_geo()->field_maxmind_database_update();
}
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_render_method() {
$pro_only = array( 'clientside', 'smart' );
$render_options = array(
'serverside' => esc_html__( 'Server-side', 'ad-commander' ),
'smart' => esc_html__( 'Smart (Combination)', 'ad-commander' ),
'clientside' => esc_html__( 'Client-side Only', 'ad-commander' ),
);
$options = $render_options;
if ( ! ProBridge::instance()->is_pro_loaded() ) {
$no_pro_options = array();
foreach ( $render_options as $key => $text ) {
if ( in_array( $key, $pro_only ) ) {
$no_pro_options[ 'disabled:' . $key ] = $text . ProBridge::pro_label();
} else {
$no_pro_options[ $key ] = $text;
}
}
$options = $no_pro_options;
}
$message = array(
'
' . $render_options['serverside'] . esc_html__( ':', 'ad-commander' ) . ' ' . esc_html__( 'Render ads with other page content. Not usually compatible with page caching and some targeting settings.', 'ad-commander' ),
'
' . $render_options['smart'] . esc_html__( ':', 'ad-commander' ) . ' ' . esc_html__( 'Client-side if group settings, targeting methods, or other settings are likely to conflict with page caching. Otherwise, uses server-side.', 'ad-commander' ),
'
' . $render_options['clientside'] . esc_html__( ':', 'ad-commander' ) . ' ' . esc_html__( 'Render ads after other page content loads using javascript. Circumvents page caching and works with all visitor targeting methods.', 'ad-commander' ),
);
array_walk(
$message,
function ( &$item ) {
$item = '
• ' . $item . '';
}
);
$message = '
' . implode( '', $message ) . '
';
$id = array( $this->sf()->key( 'general' ) => 'render_method' );
$current_value = $this->sf()->get( 'render_method', 'general' );
$this->sf()->select(
$id,
$options,
$current_value ? $current_value : array_key_first( $options ),
);
Doc::doc_link( 'rendering' );
$this->sf()->message( $message );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_ad_label() {
$id = array( $this->sf()->key( 'general' ) => 'ad_label' );
$this->sf()->checkbox( $id, $this->sf()->get( 'ad_label', 'general' ) );
$this->sf()->label( $id, __( 'Display ad label above ads or groups', 'ad-commander' ) );
echo wp_kses_post( '
' );
$id = array( $this->sf()->key( 'general' ) => 'ad_label_text' );
$this->sf()->input( $id, $this->sf()->get( 'ad_label_text', 'general', __( 'Advertisement', 'ad-commander' ) ) );
echo wp_kses_post( '
' );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_prefix() {
$id = array( $this->sf()->key( 'general' ) => 'prefix' );
$this->sf()->input( $id, $this->sf()->get( 'prefix', 'general', Util::prefix() ) );
$this->sf()->message( __( 'Using a unique prefix may help circumvent ad blockers. Recommended length is 5-7 characters and it should contain only alpha letters.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_loading_animation() {
$id = array( $this->sf()->key( 'general' ) => 'loading_animation' );
$this->sf()->checkbox( $id, $this->sf()->get( 'loading_animation', 'general' ) );
$this->sf()->label( $id, __( 'Show loading animation before ads display', 'ad-commander' ) );
$this->sf()->message( __( 'Only applies to ads and groups loaded client-side, and only to the first ad on the page.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_lazy_load_ads() {
$id = array( $this->sf()->key( 'general' ) => 'lazy_load_ads' );
$label = __( "Don't load ads until they enter viewport", 'ad-commander' );
$current_value = 0;
$disabled = true;
if ( ProBridge::instance()->is_pro_loaded() ) {
$current_value = $this->sf()->get( 'lazy_load_ads', 'general' );
$disabled = false;
} else {
$label .= ProBridge::pro_label();
}
$this->sf()->checkbox( $id, $current_value, 1, array( 'disabled' => $disabled ) );
$this->sf()->label( $id, $label );
Doc::doc_link( 'lazy_load_ads' );
$message = esc_html__( 'Lazy loading ads requires smart or client-side rendering.', 'ad-commander' );
if ( ! $disabled && $current_value === 1 && Util::render_method() === 'serverside' ) {
$message = '
' . $message . '';
}
$message .= ' ' . esc_html__( 'If tracking is enabled, impressions will track when the ad loads.', 'ad-commander' );
$this->sf()->message( $message );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_onboarding_global() {
$id = array( $this->sf()->key( 'admin' ) => 'disable_onboarding_global' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_onboarding_global', 'admin' ) );
$this->sf()->label( $id, __( 'Disable onboarding message and help links', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_onboarding_ads() {
$id = array( $this->sf()->key( 'admin' ) => 'disable_onboarding_ads' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_onboarding_ads', 'admin' ) );
$this->sf()->label( $id, __( 'Disable message that appears after new ad is published', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_doc_links() {
$id = array( $this->sf()->key( 'admin' ) => 'disable_doc_links' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_doc_links', 'admin' ) );
$this->sf()->label( $id, __( 'Disable documentation links throughout plugin', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_virtual_adstxt() {
$id = array( $this->sf()->key( 'general' ) => 'disable_virtual_adstxt' );
$disabled = false;
$disabled_text = '';
$current_value = $this->sf()->get( 'disable_virtual_adstxt', 'general' );
$ads_txt = new AdsTxt();
$can_generate = $ads_txt->can_generate_ads_txt( true );
if ( $can_generate === false || ( is_array( $can_generate ) && isset( $can_generate['can'] ) && $can_generate['can'] === false ) ) {
if ( isset( $can_generate['message'] ) && $can_generate['message'] !== '' ) {
$disabled_text = $can_generate['message'];
} else {
$disabled_text = __( 'Virtual ads.txt is disabled due to incompatibility with your site.', 'ad-commander' );
}
$disabled = true;
$current_value = 1;
} elseif ( $ads_txt->alternate_file_exists() ) {
$disabled_text = __( 'A physical ads.txt or one generated by another plugin already exists. We suggest disabling this setting or removing the other ads.txt.', 'ad-commander' );
} elseif ( is_array( $can_generate ) && isset( $can_generate['message'] ) && $can_generate['message'] !== '' ) {
$disabled_text = $can_generate['message'];
}
$this->sf()->checkbox( $id, $current_value, 1, array( 'disabled' => $disabled ) );
$this->sf()->label( $id, __( 'Do not generate a virtual ads.txt', 'ad-commander' ) );
if ( $disabled_text !== '' ) {
$this->info( $disabled_text, array( 'adcmdr-metaitem__warning' ) );
}
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_ads_txt_records() {
$id = array( $this->sf()->key( 'general' ) => 'ads_txt_records' );
$this->sf()->message( __( 'One record per line. AdSense is automatically included if publisher ID is set. Add additional records here.', 'ad-commander' ) );
$ads_txt = new AdsTxt();
$output = $ads_txt->adsense_ads_txt_line();
if ( $output != '' ) {
$this->sf()->message(
'
' . $output . '',
array(
'classes' => 'adcmdr-readonly',
'element' => 'div',
)
);
}
$this->sf()->textarea( $id, $this->sf()->get( 'ads_txt_records', 'general' ) );
/* translators: %1$s: anchor tag with URL, %2$s text representation of URL, %3$s: close anchor tag */
$message = sprintf( __( 'You can preview your ads.txt at %1$s%2$s%3$s', 'ad-commander' ), '
', site_url( 'ads.txt' ), '' );
$this->sf()->message( $message );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_newwindow() {
$id = array( $this->sf()->key( 'general' ) => 'newwindow' );
$this->sf()->checkbox( $id, $this->sf()->get( 'newwindow', 'general' ) );
$this->sf()->label( $id, __( 'Open links in a new window', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_rel_attributes() {
$id = array( $this->sf()->key( 'general' ) => 'rel_attributes' );
$checkboxes = array(
'sponsored' => '
rel=sponsored',
'nofollow' => '
rel=nofollow',
'noreferrer' => '
rel=noreferer',
'noopener' => '
rel=noopener',
);
$this->sf()->checkgroup( $id, $checkboxes, $this->sf()->get( 'rel_attributes', 'general' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_responsive_banners() {
$id = array( $this->sf()->key( 'general' ) => 'responsive_banners' );
$this->sf()->checkbox( $id, $this->sf()->get( 'responsive_banners', 'general' ) );
$this->sf()->label( $id, __( 'Include responsive styles for images in ads', 'ad-commander' ) );
/* translators: %1$s: CSS 'auto' code, %2$s, CSS '100%' code */
$message = sprintf( __( 'Images will have max-width set to %1$s and height set to %2$s. Theme styles may override this setting.', 'ad-commander' ), '
100%', '
auto' );
$this->sf()->message( $message );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_filter_priority() {
$id = array( $this->sf()->key( 'general' ) => 'filter_priority' );
$priority = $this->sf()->get( 'filter_priority', 'general' );
$this->sf()->input( $id, $priority ? $priority : Placement::placement_priority_default(), 'number' );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_stylesheets() {
$id = array( $this->sf()->key( 'general' ) => 'disable_stylesheets' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_stylesheets', 'general' ) );
$this->sf()->label( $id, __( 'Disable all front-end plugin stylesheets (some ads may not display correctly)', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_bots_disable_ads() {
$id = array( $this->sf()->key( 'general' ) => 'bots_disable_ads' );
$this->sf()->checkbox( $id, $this->sf()->get( 'bots_disable_ads', 'general' ) );
$this->sf()->label( $id, __( 'Hide ads for suspected bots - use with caution', 'ad-commander' ) );
Doc::doc_link( 'bots' );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_all() {
$id = array( $this->sf()->key( 'general' ) => 'disable_all' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_all', 'general' ) );
$this->sf()->label( $id, __( 'Disable all ads for everyone', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_user_roles() {
$roles = TargetingVisitor::parse_roles_to_values();
$id = array( $this->sf()->key( 'general' ) => 'disable_user_roles' );
$this->sf()->checkgroup( $id, $roles, $this->sf()->get( 'disable_user_roles', 'general' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_allow_editors() {
$id = array( $this->sf()->key( 'admin' ) => 'allow_editors' );
$this->sf()->checkbox( $id, $this->sf()->get( 'allow_editors', 'admin' ) );
$this->sf()->label( $id, __( 'Allow editors to manage Ad Commander', 'ad-commander' ) );
$this->sf()->message( __( 'Only administrators - or those with manage_options capability - will have access to settings.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_allow_unfiltered_html() {
$id = array( $this->sf()->key( 'admin' ) => 'allow_unfiltered_html' );
$this->sf()->checkbox( $id, $this->sf()->get( 'allow_unfiltered_html', 'admin' ) );
$this->sf()->label( $id, __( 'Allow unfiltered HTML by administrators and editors', 'ad-commander' ) );
$this->sf()->message( __( 'By default, only Super Admins can add unfiltered HTML in a multisite installation.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_delete_data() {
$id = array( $this->sf()->key( 'admin' ) => 'delete_data' );
$this->sf()->checkbox( $id, $this->sf()->get( 'delete_data', 'admin' ) );
/* translators: %1$s: open span tag with class; %2$s close span tag */
$this->sf()->label( $id, sprintf( __( '%1$sDANGER:%2$s Delete all plugin data (ads, groups, stats, options, etc) when plugin deactivated', 'ad-commander' ), '
', '' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_track_impressions() {
$id = array( $this->sf()->key( 'tracking' ) => 'disable_track_impressions' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_track_impressions', 'tracking' ) );
$this->sf()->label( $id, __( 'Disable impression tracking for all ads', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_track_clicks() {
$id = array( $this->sf()->key( 'tracking' ) => 'disable_track_clicks' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_track_clicks', 'tracking' ) );
$this->sf()->label( $id, __( 'Disable click tracking for all ads', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_enable_local_tracking() {
$id = array( $this->sf()->key( 'tracking' ) => 'enable_local_tracking' );
$this->sf()->checkbox( $id, $this->sf()->get( 'enable_local_tracking', 'tracking' ) );
$this->sf()->label( $id, __( 'Enable local tracking', 'ad-commander' ) );
Doc::doc_link( 'tracking_methods' );
$this->sf()->message( __( 'Local tracking is required for Ad Commander reports and to expire ads at maximum impressions or clicks. If not using this features, disabling may increase performance.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_enable_3p_tracking() {
$id = array( $this->sf()->key( 'tracking' ) => 'enable_3p_tracking' );
$label = __( 'Enable 3rd-party tracking', 'ad-commander' );
$current_value = 0;
$disabled = true;
if ( ProBridge::instance()->is_pro_loaded() ) {
$current_value = $this->sf()->get( 'enable_3p_tracking', 'tracking' );
$disabled = false;
} else {
$label .= ProBridge::pro_label();
}
$this->sf()->checkbox( $id, $current_value, 1, array( 'disabled' => $disabled ) );
$this->sf()->label( $id, $label );
Doc::doc_link( 'third_party_tracking' );
$this->sf()->message( __( 'Third-party tracking requires implementation of custom tracking code. See help doc for more information.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_enable_ga_tracking() {
$id = array( $this->sf()->key( 'tracking' ) => 'enable_ga_tracking' );
$label = __( 'Enable Google Analytics tracking', 'ad-commander' );
$disabled = true;
$current_value = 0;
if ( ProBridge::instance()->is_pro_loaded() ) {
$current_value = $this->sf()->get( 'enable_ga_tracking', 'tracking' );
$disabled = false;
} else {
$label .= ProBridge::pro_label();
}
$this->sf()->checkbox( $id, $current_value, 1, array( 'disabled' => $disabled ) );
$this->sf()->label( $id, $label );
Doc::doc_link( 'tracking_methods' );
$this->sf()->message( __( 'GA tracking will send events for impression and click to Google Analytics.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_ga_tracking_ids() {
$id = array( $this->sf()->key( 'tracking' ) => 'ga_tracking_ids' );
$this->sf()->input( $id, $this->sf()->get( 'ga_tracking_ids', 'tracking' ) );
/* translators: %1$s: sample Google Analytics ID */
$this->sf()->message( sprintf( __( 'One or more GA4 property IDs where clicks and impressions should be sent. Comma separated. Example: %1$s', 'ad-commander' ), '
G-XXXXXXXXXX' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_ga_anonymize_ip() {
$id = array( $this->sf()->key( 'tracking' ) => 'ga_anonymize_ip' );
$this->sf()->checkbox( $id, $this->sf()->get( 'ga_anonymize_ip', 'tracking' ) );
$this->sf()->label( $id, __( 'Tell Google Ananlytics to anonymize IPs', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_amp_analytics() {
$id = array( $this->sf()->key( 'tracking' ) => 'disable_amp_analytics' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_amp_analytics', 'tracking' ) );
$this->sf()->label( $id, __( 'Disable AMP analytics', 'ad-commander' ) );
$this->sf()->message( esc_html__( 'Used for GA impression tracking of AMP sites.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_amp_pixel() {
$id = array( $this->sf()->key( 'tracking' ) => 'disable_amp_pixel' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_amp_pixel', 'tracking' ) );
$this->sf()->label( $id, __( 'Disable AMP pixel', 'ad-commander' ) );
$this->sf()->message( esc_html__( 'Used for local impression tracking of AMP sites.', 'ad-commander' ) );
if ( ! is_ssl() ) {
$this->info( esc_html__( 'AMP pixel requires your site to use HTTPS.', 'ad-commander' ), array( 'adcmdr-metaitem__warning' ) );
}
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_bots_disable_tracking() {
$id = array( $this->sf()->key( 'tracking' ) => 'bots_disable_tracking' );
$this->sf()->checkbox( $id, $this->sf()->get( 'bots_disable_tracking', 'tracking' ) );
$this->sf()->label( $id, __( 'Disable tracking for bots - use with caution', 'ad-commander' ) );
Doc::doc_link( 'bots' );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_adsense_account() {
$pub_id = $this->sf()->get( 'adsense_account', 'adsense' );
$adsense_connected = AdminAdsense::instance()->has_access_token( $pub_id );
if ( $adsense_connected && ! $pub_id ) {
AdminAdsense::instance()->revoke_access( $pub_id );
$adsense_connected = false;
}
?>
sf()->message( esc_html__( 'Or enter your publisher ID manually for limited functionality.', 'ad-commander' ) );
} elseif ( $adsense_connected && $pub_id ) {
$adsense_api = AdminAdSense::get_adsense_api_account();
if ( isset( $adsense_api['accounts'][ $pub_id ] ) && isset( $adsense_api['accounts'][ $pub_id ]['account_details'] ) ) {
$pub_label .= '
(' . '' . esc_html( $adsense_api['accounts'][ $pub_id ]['account_details']['account_name'] ) . ')';
}
if ( ! Options::instance()->get( 'disable_adsense_account_alerts', 'adsense', true ) ) {
$alerts = AdminNotifications::instance()->test_adsense_alerts();
if ( $alerts && ! empty( $alerts ) ) {
$account_message = $this->info( '
' . '
' . esc_html__( 'View account alerts', 'ad-commander' ) . ' >', array( 'adcmdr-metaitem__warning' ), array( 'display' => false ) );
}
}
}
$pub_label .= esc_html_x( ':', 'After publisher ID label', 'ad-commander' );
$id = array( $this->sf()->key( 'adsense' ) => 'adsense_account' );
$this->sf()->label( $id, $pub_label );
echo '
';
$this->sf()->input(
$id,
$pub_id,
'text',
array(
'placeholder' => 'pub-XXXXXXXXXX',
'readonly' => (bool) $adsense_connected,
)
);
if ( ! $adsense_connected && $pub_id && ! AdSense::instance()->is_publisher_id_valid( $pub_id ) ) {
$this->info( esc_html__( 'Your publisher ID appears to be an invalid format. It should start with pub-', 'ad-commander' ), array( 'adcmdr-metaitem__error' ) );
}
echo wp_kses_post( $account_message );
?>
sf()->key( 'adsense' ) => 'adsense_amp_ad_mode' );
$modes = AdSense::amp_modes();
unset( $modes['site_default'] );
$disabled = ! ProBridge::instance()->is_pro_loaded();
if ( $disabled ) {
$modes = Util::disable_options( $modes );
foreach ( $modes as $key => $text ) {
$modes[ $key ] = $text . ProBridge::instance()->pro_label();
}
}
$this->sf()->radiogroup( $id, $modes, $this->sf()->get( 'adsense_amp_ad_mode', 'adsense', 'automatic' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_insert_adsense_head_code() {
$id = array( $this->sf()->key( 'adsense' ) => 'insert_adsense_head_code' );
$this->sf()->checkbox( $id, $this->sf()->get( 'insert_adsense_head_code', 'adsense' ) );
$this->sf()->label( $id, __( 'Insert AdSense script in head on every page (for auto ads and site verification)', 'ad-commander' ) );
if ( Options::instance()->get( 'insert_adsense_head_code', 'adsense', true ) ) {
$this->sf()->message( '
' . htmlentities( AdSense::instance()->get_adsense_script_tag( false, 'pub-XXXXXXXXXX' ) ) . '' );
}
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_enable_amp_auto_ads() {
$id = array( $this->sf()->key( 'adsense' ) => 'enable_amp_auto_ads' );
$this->sf()->checkbox( $id, $this->sf()->get( 'enable_amp_auto_ads', 'adsense' ) );
$this->sf()->label( $id, __( 'Insert AMP auto ads code on every page', 'ad-commander' ) );
if ( Options::instance()->get( 'enable_amp_auto_ads', 'adsense', true ) ) {
$this->sf()->message( '
' . htmlentities( Amp::instance()->get_amp_auto_ads_script_tag() ) . '' );
$this->sf()->message( '
' . htmlentities( Amp::instance()->get_amp_auto_ads_element( false, 'pub-XXXXXXXXXX' ) ) . '' );
if ( ! Amp::instance()->has_amp_plugin() ) {
$this->info( __( 'No AMP plugin found. View documentation for more information.', 'ad-commander' ) . ' ' . Doc::doc_link( 'amp', false ), array( 'adcmdr-metaitem__warning' ) );
}
}
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_disable_adsense_account_alerts() {
$pub_id = $this->sf()->get( 'adsense_account', 'adsense' );
$adsense_connected = AdminAdsense::instance()->has_access_token( $pub_id );
$id = array( $this->sf()->key( 'adsense' ) => 'disable_adsense_account_alerts' );
$this->sf()->checkbox( $id, $this->sf()->get( 'disable_adsense_account_alerts', 'adsense' ), 1, array( 'disabled' => ! $adsense_connected ) );
$this->sf()->label( $id, __( 'Disable AdSense connected account alerts in the Ad Commander Dashboard', 'ad-commander' ), array( 'disabled' => ! $adsense_connected ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_consent_required() {
$id = array( $this->sf()->key( 'privacy' ) => 'consent_required' );
$this->sf()->checkbox( $id, $this->sf()->get( 'consent_required', 'privacy' ), 1 );
$this->sf()->label( $id, __( 'Require consent before displaying ads.', 'ad-commander' ) );
Doc::doc_link( 'requiring_consent' );
echo wp_kses_post( '
' );
$this->sf()->message( __( 'If enabled, this setting can be overridden by individual ads, groups, or placements.', 'ad-commander' ) );
echo wp_kses_post( '
' );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_consent_cookie_name() {
$id = array( $this->sf()->key( 'privacy' ) => 'consent_cookie_name' );
$this->sf()->input( $id, $this->sf()->get( 'consent_cookie_name', 'privacy' ) );
/* translators: %1$s: sample Google Analytics ID */
$this->sf()->message( __( 'The name of the cookie that indicates a user has given consent.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_consent_cookie_value() {
$id = array( $this->sf()->key( 'privacy' ) => 'consent_cookie_value' );
$this->sf()->input( $id, $this->sf()->get( 'consent_cookie_value', 'privacy' ) );
/* translators: %1$s: sample Google Analytics ID */
$this->sf()->message( __( 'The cookie should have this value. Leave blank to accept any value.', 'ad-commander' ) );
}
/**
* Callback for settings field.
*
* @return void
*/
public function field_adcmdr_consent_cookie_comparison() {
$options = array(
'equals' => __( 'Equals', 'ad-commander' ),
'contains' => __( 'Contains', 'ad-commander' ),
'equals_insensitive' => __( 'Equals (case-insensitive)', 'ad-commander' ),
'contains_insensitive' => __( 'Contains (case-insensitive)', 'ad-commander' ),
);
$id = array( $this->sf()->key( 'privacy' ) => 'consent_cookie_comparison' );
$current_value = $this->sf()->get( 'consent_cookie_comparison', 'privacy' );
$this->sf()->select(
$id,
$options,
$current_value ? $current_value : array_key_first( $options ),
);
$this->sf()->message( __( 'The manner in which to check the cookie value. If the cookie value above is blank, this setting is ignored and Ad Commander will check if the cookie exists.', 'ad-commander' ) );
}
/**
* Create classes for use on a meta item.
*
* @param array $suffixes An array of suffices to append.
*
* @return string
*/
public static function metaitem_classes( $suffixes = array() ) {
$classes = array( 'adcmdr-metaitem' );
if ( $suffixes && ! is_array( $suffixes ) ) {
$suffixes = array( $suffixes );
}
if ( $suffixes ) {
foreach ( $suffixes as $suffix ) {
$classes[] = 'adcmdr-metaitem--' . $suffix;
}
}
return implode( ' ', $classes );
}
/**
* Interfaces with WOMeta message and adds classes.
*
* @param string $message The message to display.
* @param array $classes Any additional classes.
* @param array $args Additional arguments.
*
* @return string
*/
protected function info( $message, $classes = array(), $args = array() ) {
$classes = Util::arrayify( $classes );
$classes[] = 'adcmdr-metaitem__info';
$args['classes'] = $classes;
$args['element'] = 'div';
$args['inner_element'] = 'p';
return $this->sf()->wo_forms->message( $message, $args );
}
/**
* Display an add-on table.
*
* @return string
*/
protected function get_addons() {
$html = '';
if ( ! ProBridge::instance()->is_pro_loaded() ) {
$lis = array(
__( 'Priority support and updates', 'ad-commander' ),
__( 'Client-side and smart rendering modes (cache busting)', 'ad-commander' ),
__( 'Google Analytics tracking (GA4)', 'ad-commander' ),
__( 'Visitor targeting options', 'ad-commander' ),
__( 'Geotargeting with MaxMind', 'ad-commander' ),
__( 'Group and placement targeting options', 'ad-commander' ),
__( 'Advanced automatic placement positions', 'ad-commander' ),
__( 'Weighted and evenly distributed ads', 'ad-commander' ),
__( 'Advanced group layouts', 'ad-commander' ),
__( 'Expire ads by date or stats', 'ad-commander' ),
__( 'Increased AdSense API calls', 'ad-commander' ),
__( '...and more', 'ad-commander' ),
);
foreach ( $lis as &$li ) {
$li = '
' . $li;
}
$html .= $this->start_div( Util::ns( 'addons' ), array( 'display' => false ) ) .
$this->start_div( array( Util::ns( 'addon-features' ), Util::ns( 'pro-features' ) ), array( 'display' => false ) ) .
Html::h3( AdCommander::title() . ' Pro' ) .
Html::ul( $lis, Util::ns( 'addon' ) ) .
$this->start_div( 'adcmdr-btn-group', array( 'display' => false ) ) .
Html::abtn( self::pro_upgrade_url( array( 'utm_medium' => 'button' ) ), __( 'Upgrade to Pro', 'ad-commander' ) ) .
Html::abtn( AdCommander::public_site_url( '', array( 'utm_medium' => 'button' ) ), 'Learn more', '_blank', true ) .
$this->end_div( array( 'display' => false ) ) .
$this->end_div( array( 'display' => false ) ) .
$this->end_div( array( 'display' => false ) );
}
if ( ! AddonBridge::instance()->is_addon_loaded( 'tools' ) ) {
$lis = array(
__( 'Export Ad Commander ads', 'ad-commander' ),
__( 'Import Ad Commander ads from another site', 'ad-commander' ),
__( 'Reset all ad statistics', 'ad-commander' ),
__( 'Reset single ad statistics', 'ad-commander' ),
__( 'Purge rogue statistics (deleted ads)', 'ad-commander' ),
__( 'Available in the WordPress plugin directory', 'ad-commander' ),
);
foreach ( $lis as &$li ) {
$li = '
' . $li;
}
$html .= $this->start_div( Util::ns( 'addons' ), array( 'display' => false ) ) .
$this->start_div( Util::ns( 'addon-features' ), array( 'display' => false ) ) .
Html::h3( __( 'Ad Commander Tools', 'ad-commander' ) ) .
Html::ul( $lis, Util::ns( 'addon' ) ) .
$this->start_div( 'adcmdr-btn-group', array( 'display' => false ) ) .
Html::abtn( AddonBridge::addon_url( 'tools' ), __( 'Download Add-on', 'ad-commander' ) ) .
$this->end_div( array( 'display' => false ) ) .
$this->end_div( array( 'display' => false ) ) .
$this->end_div( array( 'display' => false ) );
}
if ( ! AddonBridge::instance()->is_addon_loaded( 'scrnsa' ) ) {
$p = esc_html__( "Screen Stay Awake prevents your website visitor's screen from turning off. The Screen Wake Lock API is used and no visitor prompt is required.", 'ad-commander' );
$p .= '
';
$p .= esc_html__( 'This plugin is great for recipe websites and other how-to websites where a visitor would prefer their screen stay on.', 'ad-commander' );
$html .= $this->start_div( Util::ns( 'addons' ), array( 'display' => false ) ) .
$this->start_div( Util::ns( 'addon-features' ), array( 'display' => false ) ) .
Html::h3( __( 'Screen Stay Awake', 'ad-commander' ) ) .
Html::p( $p ) .
$this->start_div( 'adcmdr-btn-group', array( 'display' => false ) ) .
Html::abtn( AddonBridge::addon_url( 'scrnsa' ), __( 'Download Plugin', 'ad-commander' ) ) .
$this->end_div( array( 'display' => false ) ) .
$this->end_div( array( 'display' => false ) ) .
$this->end_div( array( 'display' => false ) );
}
if ( $html ) {
$html = '
' . $html . '
';
}
return $html;
}
/**
* Modify the ad or placement post title if it's blank.
*
* @param array $post_data The current post data.
*
* @return array
*/
public function modify_post_title( $post_data ) {
if ( $post_data['post_type'] === AdCommander::posttype_ad() || $post_data['post_type'] === AdCommander::posttype_placement() ) {
if ( ( ! isset( $post_data['post_title'] ) || trim( $post_data['post_title'] ) === '' ) && isset( $post_data['post_date_gmt'] ) ) {
$prefix = $post_data['post_type'] === AdCommander::posttype_ad() ? esc_html__( 'Ad', 'ad-commander' ) : esc_html__( 'Placement', 'ad-commander' );
$post_data['post_title'] = $prefix . ' | ' . get_date_from_gmt( $post_data['post_date_gmt'], get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) );
}
}
return $post_data;
}
}
 . 'img/logo.svg' ); ?>){kind=logo}