Edit File by line

<?php

[0] Fix | Delete

// phpcs:ignoreFile

[1] Fix | Delete

/**

[2] Fix | Delete

* Advanced Ads

[3] Fix | Delete

[4] Fix | Delete

* @package Advanced_Ads_Placements

[5] Fix | Delete

* @author Thomas Maier <support@wpadvancedads.com>

[6] Fix | Delete

* @license GPL-2.0+

[7] Fix | Delete

* @link https://wpadvancedads.com

[8] Fix | Delete

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

use AdvancedAds\Entities;

[12] Fix | Delete

use AdvancedAds\Utilities\WordPress;

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Grouping placements functions

[16] Fix | Delete

[17] Fix | Delete

* @since 1.1.0

[18] Fix | Delete

* @package Advanced_Ads_Placements

[19] Fix | Delete

* @author Thomas Maier <support@wpadvancedads.com>

[20] Fix | Delete

[21] Fix | Delete

class Advanced_Ads_Placements {

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Gather placeholders which later are replaced by the ads

[25] Fix | Delete

[26] Fix | Delete

* @var array $ads_for_placeholders

[27] Fix | Delete

[28] Fix | Delete

private static $ads_for_placeholders = [];

[29] Fix | Delete

/**

[30] Fix | Delete

* Temporarily change content during processing

[31] Fix | Delete

[32] Fix | Delete

* @var array $placements

[33] Fix | Delete

[34] Fix | Delete

private static $replacements = [

[35] Fix | Delete

'gcse:search' => 'gcse__search', // Google custom search namespaced tags.

[36] Fix | Delete

];

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Return placement page description

[40] Fix | Delete

[41] Fix | Delete

* @deprecated 1.47.0

[42] Fix | Delete

[43] Fix | Delete

* @return string

[44] Fix | Delete

[45] Fix | Delete

public static function get_description() {

[46] Fix | Delete

_deprecated_function( __METHOD__, '1.47.0', '\AdvancedAds\Entities::get_placement_description()' );

[47] Fix | Delete

return Entities::get_placement_description();

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Get placement types

[52] Fix | Delete

[53] Fix | Delete

* @return \Advanced_Ads\Placement_Type[] $types array with placement types

[54] Fix | Delete

* @since 1.2.1

[55] Fix | Delete

[56] Fix | Delete

public static function get_placement_types() {

[57] Fix | Delete

$types = [

[58] Fix | Delete

'post_top' => [

[59] Fix | Delete

'title' => __( 'Before Content', 'advanced-ads' ),

[60] Fix | Delete

'description' => __( 'Injected before the post content.', 'advanced-ads' ),

[61] Fix | Delete

'image' => ADVADS_BASE_URL . 'admin/assets/img/placements/content-before.png',

[62] Fix | Delete

'order' => 20,

[63] Fix | Delete

'options' => [

[64] Fix | Delete

'show_position' => true,

[65] Fix | Delete

'show_lazy_load' => true,

[66] Fix | Delete

'uses_the_content' => true,

[67] Fix | Delete

'amp' => true,

[68] Fix | Delete

[69] Fix | Delete

[70] Fix | Delete

'post_content' => [

[71] Fix | Delete

'title' => __( 'Content', 'advanced-ads' ),

[72] Fix | Delete

'description' => __( 'Injected into the content. You can choose the paragraph after which the ad content is displayed.', 'advanced-ads' ),

[73] Fix | Delete

'image' => ADVADS_BASE_URL . 'admin/assets/img/placements/content-within.png',

[74] Fix | Delete

'order' => 21,

[75] Fix | Delete

'options' => [

[76] Fix | Delete

'show_position' => true,

[77] Fix | Delete

'show_lazy_load' => true,

[78] Fix | Delete

'uses_the_content' => true,

[79] Fix | Delete

'amp' => true,

[80] Fix | Delete

[81] Fix | Delete

[82] Fix | Delete

'post_bottom' => [

[83] Fix | Delete

'title' => __( 'After Content', 'advanced-ads' ),

[84] Fix | Delete

'description' => __( 'Injected after the post content.', 'advanced-ads' ),

[85] Fix | Delete

'image' => ADVADS_BASE_URL . 'admin/assets/img/placements/content-after.png',

[86] Fix | Delete

'order' => 35,

[87] Fix | Delete

'options' => [

[88] Fix | Delete

'show_position' => true,

[89] Fix | Delete

'show_lazy_load' => true,

[90] Fix | Delete

'uses_the_content' => true,

[91] Fix | Delete

'amp' => true,

[92] Fix | Delete

[93] Fix | Delete

[94] Fix | Delete

'sidebar_widget' => [

[95] Fix | Delete

'title' => __( 'Sidebar Widget', 'advanced-ads' ),

[96] Fix | Delete

'description' => __( 'Create a sidebar widget with an ad. Can be placed and used like any other widget.', 'advanced-ads' ),

[97] Fix | Delete

'image' => ADVADS_BASE_URL . 'admin/assets/img/placements/widget.png',

[98] Fix | Delete

'order' => 50,

[99] Fix | Delete

'options' => [

[100] Fix | Delete

'show_position' => true,

[101] Fix | Delete

'show_lazy_load' => true,

[102] Fix | Delete

'amp' => true,

[103] Fix | Delete

[104] Fix | Delete

[105] Fix | Delete

'default' => [

[106] Fix | Delete

'title' => __( 'Manual Placement', 'advanced-ads' ),

[107] Fix | Delete

'description' => __( 'Manual placement to use as function or shortcode.', 'advanced-ads' ),

[108] Fix | Delete

'image' => ADVADS_BASE_URL . 'admin/assets/img/placements/manual.png',

[109] Fix | Delete

'order' => 80,

[110] Fix | Delete

'options' => [

[111] Fix | Delete

'show_position' => true,

[112] Fix | Delete

'show_lazy_load' => true,

[113] Fix | Delete

'amp' => true,

[114] Fix | Delete

[115] Fix | Delete

[116] Fix | Delete

'header' => [

[117] Fix | Delete

'title' => __( 'Header Code', 'advanced-ads' ),

[118] Fix | Delete

'description' => __( 'Injected in Header (before closing </head> Tag, often not visible).', 'advanced-ads' ),

[119] Fix | Delete

'image' => ADVADS_BASE_URL . 'admin/assets/img/placements/header.png',

[120] Fix | Delete

'order' => 3,

[121] Fix | Delete

[122] Fix | Delete

'footer' => [

[123] Fix | Delete

'title' => __( 'Footer Code', 'advanced-ads' ),

[124] Fix | Delete

'description' => __( 'Injected in Footer (before closing </body> Tag).', 'advanced-ads' ),

[125] Fix | Delete

'image' => ADVADS_BASE_URL . 'admin/assets/img/placements/footer.png',

[126] Fix | Delete

'order' => 95,

[127] Fix | Delete

'options' => [ 'amp' => true ],

[128] Fix | Delete

[129] Fix | Delete

];

[130] Fix | Delete

[131] Fix | Delete

$types = (array) apply_filters( 'advanced-ads-placement-types', $types );

[132] Fix | Delete

[133] Fix | Delete

foreach ( $types as $type => $definition ) {

[134] Fix | Delete

$types[ $type ] = new \Advanced_Ads\Placement_Type( $type, $definition );

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

return $types;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Update placements if sent

[142] Fix | Delete

[143] Fix | Delete

* @since 1.5.2

[144] Fix | Delete

[145] Fix | Delete

public static function update_placements() {

[146] Fix | Delete

[147] Fix | Delete

// check user permissions.

[148] Fix | Delete

if ( ! WordPress::user_can( 'advanced_ads_manage_placements' ) ) {

[149] Fix | Delete

return;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

$success = null;

[153] Fix | Delete

[154] Fix | Delete

// add hook of last opened placement settings to URL.

[155] Fix | Delete

$hook = ! empty( $_POST['advads-last-edited-placement'] ) ? '#single-placement-' . $_POST['advads-last-edited-placement'] : '';

[156] Fix | Delete

[157] Fix | Delete

if ( isset( $_POST['advads']['placement'] ) && check_admin_referer( 'advads-placement', 'advads_placement' ) ) {

[158] Fix | Delete

$success = self::save_new_placement( $_POST['advads']['placement'] );

[159] Fix | Delete

}

[160] Fix | Delete

// save placement data.

[161] Fix | Delete

if ( isset( $_POST['advads']['placements'] ) && check_admin_referer( 'advads-placement', 'advads_placement' ) ) {

[162] Fix | Delete

$success = self::save_placements( $_POST['advads']['placements'] );

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

$success = apply_filters( 'advanced-ads-update-placements', $success );

[166] Fix | Delete

[167] Fix | Delete

if ( isset( $success ) ) {

[168] Fix | Delete

$message = $success ? 'updated' : 'error';

[169] Fix | Delete

wp_redirect( esc_url_raw( add_query_arg( [ 'message' => $message ] ) ) . $hook );

[170] Fix | Delete

}

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Save a new placement

[175] Fix | Delete

[176] Fix | Delete

* @param array $new_placement information about the new placement.

[177] Fix | Delete

[178] Fix | Delete

* @return mixed slug if saved; false if not

[179] Fix | Delete

* @since 1.1.0

[180] Fix | Delete

[181] Fix | Delete

public static function save_new_placement( $new_placement ) {

[182] Fix | Delete

// load placements // -TODO use model.

[183] Fix | Delete

$placements = Advanced_Ads::get_ad_placements_array();

[184] Fix | Delete

[185] Fix | Delete

// create slug.

[186] Fix | Delete

$new_placement['slug'] = sanitize_title( $new_placement['name'] );

[187] Fix | Delete

[188] Fix | Delete

if ( isset( $placements[ $new_placement['slug'] ] ) ) {

[189] Fix | Delete

$i = 1;

[190] Fix | Delete

// try to save placement until we found an empty slug.

[191] Fix | Delete

do {

[192] Fix | Delete

$i ++;

[193] Fix | Delete

if ( 100 === $i ) { // prevent endless loop, just in case.

[194] Fix | Delete

Advanced_Ads::log( 'endless loop when injecting placement' );

[195] Fix | Delete

break;

[196] Fix | Delete

}

[197] Fix | Delete

} while ( isset( $placements[ $new_placement['slug'] . '_' . $i ] ) );

[198] Fix | Delete

[199] Fix | Delete

$new_placement['slug'] .= '_' . $i;

[200] Fix | Delete

$new_placement['name'] .= ' ' . $i;

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

// check if slug already exists or is empty.

[204] Fix | Delete

if ( '' === $new_placement['slug'] || isset( $placements[ $new_placement['slug'] ] ) || ! isset( $new_placement['type'] ) ) {

[205] Fix | Delete

return false;

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

// make sure only allowed types are being saved.

[209] Fix | Delete

$placement_types = self::get_placement_types();

[210] Fix | Delete

$new_placement['type'] = ( isset( $placement_types[ $new_placement['type'] ] ) ) ? $new_placement['type'] : 'default';

[211] Fix | Delete

// escape name.

[212] Fix | Delete

$new_placement['name'] = esc_attr( $new_placement['name'] );

[213] Fix | Delete

[214] Fix | Delete

// add new place to all placements.

[215] Fix | Delete

$placements[ $new_placement['slug'] ] = [

[216] Fix | Delete

'type' => $new_placement['type'],

[217] Fix | Delete

'name' => $new_placement['name'],

[218] Fix | Delete

'item' => $new_placement['item'],

[219] Fix | Delete

];

[220] Fix | Delete

[221] Fix | Delete

// add index options.

[222] Fix | Delete

if ( isset( $new_placement['options'] ) ) {

[223] Fix | Delete

$placements[ $new_placement['slug'] ]['options'] = $new_placement['options'];

[224] Fix | Delete

if ( isset( $placements[ $new_placement['slug'] ]['options']['index'] ) ) {

[225] Fix | Delete

$placements[ $new_placement['slug'] ]['options']['index'] = absint( $placements[ $new_placement['slug'] ]['options']['index'] );

[226] Fix | Delete

}

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

// save array.

[230] Fix | Delete

Advanced_Ads::get_instance()->get_model()->update_ad_placements_array( $placements );

[231] Fix | Delete

[232] Fix | Delete

return $new_placement['slug'];

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

/**

[236] Fix | Delete

* Save placements

[237] Fix | Delete

[238] Fix | Delete

* @param array $placement_items placements.

[239] Fix | Delete

[240] Fix | Delete

* @return mixed true if saved; error message if not

[241] Fix | Delete

* @since 1.1.0

[242] Fix | Delete

[243] Fix | Delete

public static function save_placements( $placement_items ) {

[244] Fix | Delete

[245] Fix | Delete

// load placements // -TODO use model.

[246] Fix | Delete

$placements = Advanced_Ads::get_ad_placements_array();

[247] Fix | Delete

[248] Fix | Delete

foreach ( $placement_items as $_placement_slug => $_placement ) {

[249] Fix | Delete

// remove the placement.

[250] Fix | Delete

if ( isset( $_placement['delete'] ) ) {

[251] Fix | Delete

unset( $placements[ $_placement_slug ] );

[252] Fix | Delete

continue;

[253] Fix | Delete

}

[254] Fix | Delete

// save item.

[255] Fix | Delete

if ( isset( $_placement['item'] ) ) {

[256] Fix | Delete

$placements[ $_placement_slug ]['item'] = $_placement['item'];

[257] Fix | Delete

}

[258] Fix | Delete

// save item options.

[259] Fix | Delete

if ( isset( $_placement['options'] ) ) {

[260] Fix | Delete

$placements[ $_placement_slug ]['options'] = $_placement['options'];

[261] Fix | Delete

if ( isset( $placements[ $_placement_slug ]['options']['index'] ) ) {

[262] Fix | Delete

$placements[ $_placement_slug ]['options']['index'] = absint( $placements[ $_placement_slug ]['options']['index'] );

[263] Fix | Delete

}

[264] Fix | Delete

} else {

[265] Fix | Delete

$placements[ $_placement_slug ]['options'] = [];

[266] Fix | Delete

}

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

// save array.

[270] Fix | Delete

Advanced_Ads::get_instance()->get_model()->update_ad_placements_array( $placements );

[271] Fix | Delete

[272] Fix | Delete

return true;

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

/**

[276] Fix | Delete

* Get items for item select field.

[277] Fix | Delete

* Used for new placement form.

[278] Fix | Delete

[279] Fix | Delete

* @return array $select items for select field

[280] Fix | Delete

[281] Fix | Delete

public static function items_for_select() {

[282] Fix | Delete

$select = [];

[283] Fix | Delete

$model = Advanced_Ads::get_instance()->get_model();

[284] Fix | Delete

[285] Fix | Delete

// load all ad groups.

[286] Fix | Delete

$groups = $model->get_ad_groups();

[287] Fix | Delete

foreach ( $groups as $_group ) {

[288] Fix | Delete

$select['groups'][ 'group_' . $_group->term_id ] = $_group->name;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

// load all ads.

[292] Fix | Delete

$ads = $model->get_ads(

[293] Fix | Delete

[

[294] Fix | Delete

'orderby' => 'title',

[295] Fix | Delete

'order' => 'ASC',

[296] Fix | Delete

]

[297] Fix | Delete

);

[298] Fix | Delete

foreach ( $ads as $_ad ) {

[299] Fix | Delete

$select['ads'][ 'ad_' . $_ad->ID ] = $_ad->post_title;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

return $select;

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

/**

[306] Fix | Delete

* Get html tags for content injection

[307] Fix | Delete

[308] Fix | Delete

* @return array $tags array with tags that can be used for content injection

[309] Fix | Delete

* @since 1.3.5

[310] Fix | Delete

[311] Fix | Delete

public static function tags_for_content_injection() {

[312] Fix | Delete

$headline_tags = apply_filters( 'advanced-ads-headlines-for-ad-injection', [ 'h2', 'h3', 'h4' ] );

[313] Fix | Delete

$headline_tags_imploded = '<' . implode( '>, <', $headline_tags ) . '>';

[314] Fix | Delete

[315] Fix | Delete

$tags = apply_filters(

[316] Fix | Delete

'advanced-ads-tags-for-injection',

[317] Fix | Delete

[

[318] Fix | Delete