Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Advanced Ads Widget

[2] Fix | Delete

[3] Fix | Delete

* @package Advanced_Ads_Widget

[4] Fix | Delete

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

[5] Fix | Delete

* @license GPL-2.0+

[6] Fix | Delete

* @link https://wpadvancedads.com

[7] Fix | Delete

[8] Fix | Delete

[9] Fix | Delete

[10] Fix | Delete

use AdvancedAds\Utilities\Groups;

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Ad widget

[14] Fix | Delete

[15] Fix | Delete

class Advanced_Ads_Widget extends WP_Widget {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Allows the REST API to see the widgets instance.

[19] Fix | Delete

[20] Fix | Delete

* @deprecated deprecated since WordPress version 5.8

[21] Fix | Delete

* @var bool

[22] Fix | Delete

[23] Fix | Delete

public $show_instance_in_rest = true;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Advanced_Ads_Widget constructor.

[27] Fix | Delete

[28] Fix | Delete

public function __construct() {

[29] Fix | Delete

$prefix = Advanced_Ads_Plugin::get_instance()->get_frontend_prefix();

[30] Fix | Delete

$classname = $prefix . 'widget';

[31] Fix | Delete

[32] Fix | Delete

$widget_ops = [

[33] Fix | Delete

'classname' => $classname,

[34] Fix | Delete

'show_instance_in_rest' => true,

[35] Fix | Delete

'description' => __( 'Display Ads and Ad Groups.', 'advanced-ads' ),

[36] Fix | Delete

];

[37] Fix | Delete

$control_ops = [];

[38] Fix | Delete

$base_id = self::get_base_id();

[39] Fix | Delete

[40] Fix | Delete

parent::__construct( $base_id, 'Advanced Ads', $widget_ops, $control_ops );

[41] Fix | Delete

[42] Fix | Delete

add_filter( 'q2w3-fixed-widgets', [ $this, 'q2w3_replace_frontend_id' ] );

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Echoes the widget content.

[47] Fix | Delete

[48] Fix | Delete

* @param array $args Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.

[49] Fix | Delete

* @param array $instance The settings for the particular instance of the widget.

[50] Fix | Delete

[51] Fix | Delete

public function widget( $args, $instance ) {

[52] Fix | Delete

/** This filter is documented in wp-includes/default-widgets.php */

[53] Fix | Delete

$title = apply_filters( 'widget_title', empty( $instance['title'] ) ? '' : $instance['title'], $instance, $this->id_base );

[54] Fix | Delete

[55] Fix | Delete

$item_id = empty( $instance['item_id'] ) ? '' : $instance['item_id'];

[56] Fix | Delete

[57] Fix | Delete

$output = self::output( $item_id );

[58] Fix | Delete

if ( ! $output ) {

[59] Fix | Delete

return;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

$before_widget = isset( $args['before_widget'] ) ? $args['before_widget'] : '';

[63] Fix | Delete

$after_widget = isset( $args['after_widget'] ) ? $args['after_widget'] : '';

[64] Fix | Delete

[65] Fix | Delete

$before_widget = $this->maybe_replace_frontend_id( $before_widget, $instance );

[66] Fix | Delete

[67] Fix | Delete

echo $before_widget;

[68] Fix | Delete

if ( ! empty( $title ) ) {

[69] Fix | Delete

echo $args['before_title'] . $title . $args['after_title'];

[70] Fix | Delete

}

[71] Fix | Delete

echo $output;

[72] Fix | Delete

echo $after_widget;

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Updates a particular instance of a widget.

[77] Fix | Delete

[78] Fix | Delete

* This function should check that `$new_instance` is set correctly. The newly-calculated

[79] Fix | Delete

* value of `$instance` should be returned. If false is returned, the instance won't be

[80] Fix | Delete

* saved/updated.

[81] Fix | Delete

[82] Fix | Delete

* @param array $new_instance New settings for this instance as input by the user via WP_Widget::form().

[83] Fix | Delete

* @param array $old_instance Old settings for this instance.

[84] Fix | Delete

* @return array Settings to save or bool false to cancel saving.

[85] Fix | Delete

[86] Fix | Delete

public function update( $new_instance, $old_instance ) {

[87] Fix | Delete

$instance = $old_instance;

[88] Fix | Delete

$instance['title'] = $new_instance['title'];

[89] Fix | Delete

$instance['item_id'] = $new_instance['item_id'];

[90] Fix | Delete

[91] Fix | Delete

// Allow to remove/replace id for new widgets and if it was allowed earlier.

[92] Fix | Delete

if ( [] === $old_instance || ! empty( $old_instance['remove-widget-id'] ) ) {

[93] Fix | Delete

$instance['remove-widget-id'] = true;

[94] Fix | Delete

}

[95] Fix | Delete

return $instance;

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Outputs the settings update form.

[100] Fix | Delete

[101] Fix | Delete

* @param array $instance Current settings.

[102] Fix | Delete

[103] Fix | Delete

public function form( $instance ) {

[104] Fix | Delete

$instance = wp_parse_args(

[105] Fix | Delete

(array) $instance,

[106] Fix | Delete

[

[107] Fix | Delete

'title' => '',

[108] Fix | Delete

'item_id' => '',

[109] Fix | Delete

]

[110] Fix | Delete

);

[111] Fix | Delete

$title = strip_tags( $instance['title'] );

[112] Fix | Delete

$elementid = $instance['item_id'];

[113] Fix | Delete

[114] Fix | Delete

?><p><label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'advanced-ads' ); ?></label>

[115] Fix | Delete

<input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" /></p>

[116] Fix | Delete

<?php

[117] Fix | Delete

$items = array_merge( self::items_for_select(), self::widget_placements_for_select() );

[118] Fix | Delete

[119] Fix | Delete

<select id="<?php echo esc_attr( $this->get_field_id( 'item_id' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'item_id' ) ); ?>">

[120] Fix | Delete

[121] Fix | Delete

<?php if ( isset( $items['placements'] ) ) : ?>

[122] Fix | Delete

[123] Fix | Delete

<?php foreach ( $items['placements'] as $_item_id => $_item_title ) : ?>

[124] Fix | Delete

[125] Fix | Delete

<?php endforeach; ?>

[126] Fix | Delete

</optgroup>

[127] Fix | Delete

<?php endif; ?>

[128] Fix | Delete

<?php if ( isset( $items['groups'] ) ) : ?>

[129] Fix | Delete

[130] Fix | Delete

<?php foreach ( $items['groups'] as $_item_id => $_item_title ) : ?>

[131] Fix | Delete

[132] Fix | Delete

<?php endforeach; ?>

[133] Fix | Delete

</optgroup>

[134] Fix | Delete

<?php endif; ?>

[135] Fix | Delete

<?php if ( isset( $items['ads'] ) ) : ?>

[136] Fix | Delete

[137] Fix | Delete

<?php foreach ( $items['ads'] as $_item_id => $_item_title ) : ?>

[138] Fix | Delete

[139] Fix | Delete

<?php endforeach; ?>

[140] Fix | Delete

</optgroup>

[141] Fix | Delete

<?php endif; ?>

[142] Fix | Delete

</select>

[143] Fix | Delete

[144] Fix | Delete

<?php

[145] Fix | Delete

$this->display_hints( $elementid );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Display hints related to the currently selected item in the dropdown.

[150] Fix | Delete

[151] Fix | Delete

* @param string $elementid Currently selected item.

[152] Fix | Delete

[153] Fix | Delete

private function display_hints( $elementid ) {

[154] Fix | Delete

$elementid_parts = explode( '_', $elementid );

[155] Fix | Delete

if ( ! isset( $elementid_parts[1] ) || $elementid_parts[0] !== 'group' ) {

[156] Fix | Delete

return;

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

echo Groups::build_hints_html( new Advanced_Ads_Group( $elementid_parts[1] ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Get items for widget select field

[164] Fix | Delete

[165] Fix | Delete

* @return array $select items for select field.

[166] Fix | Delete

[167] Fix | Delete

public static function items_for_select() {

[168] Fix | Delete

$select = [];

[169] Fix | Delete

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

[170] Fix | Delete

[171] Fix | Delete

// load all ads.

[172] Fix | Delete

$ads = $model->get_ads(

[173] Fix | Delete

[

[174] Fix | Delete

'orderby' => 'title',

[175] Fix | Delete

'order' => 'ASC',

[176] Fix | Delete

]

[177] Fix | Delete

);

[178] Fix | Delete

foreach ( $ads as $_ad ) {

[179] Fix | Delete

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

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

// load all ad groups.

[183] Fix | Delete

$groups = $model->get_ad_groups();

[184] Fix | Delete

foreach ( $groups as $_group ) {

[185] Fix | Delete

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

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

return $select;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Get widget placements for select field

[193] Fix | Delete

[194] Fix | Delete

* @return array $items for select field.

[195] Fix | Delete

[196] Fix | Delete

public static function widget_placements_for_select() {

[197] Fix | Delete

$select = [];

[198] Fix | Delete

$placements = Advanced_Ads::get_instance()->get_model()->get_ad_placements_array();

[199] Fix | Delete

[200] Fix | Delete

if ( is_array( $placements ) ) {

[201] Fix | Delete

ksort( $placements );

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

foreach ( $placements as $placement_slug => $placement ) {

[205] Fix | Delete

if ( isset( $placement['type'] ) && in_array( $placement['type'], [ 'sidebar_widget', 'default' ], true ) ) {

[206] Fix | Delete

$select['placements'][ 'placement_' . $placement_slug ] = $placement['name'];

[207] Fix | Delete

}

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

return $select;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Return content of an in a widget

[215] Fix | Delete

[216] Fix | Delete

* @param string $id slug of the display.

[217] Fix | Delete

* @return bool|string

[218] Fix | Delete

[219] Fix | Delete

public static function output( $id = '' ) {

[220] Fix | Delete

// get placement data for the slug.

[221] Fix | Delete

if ( empty( $id ) ) {

[222] Fix | Delete

return; }

[223] Fix | Delete

[224] Fix | Delete

$item = explode( '_', $id, 2 );

[225] Fix | Delete

[226] Fix | Delete

if ( isset( $item[1] ) ) {

[227] Fix | Delete

$item_id = $item[1];

[228] Fix | Delete

} elseif ( empty( $item_id ) ) {

[229] Fix | Delete

return;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

// return either ad or group content.

[233] Fix | Delete

if ( 'ad' === $item[0] ) {

[234] Fix | Delete

return get_ad( absint( $item_id ) );

[235] Fix | Delete

} elseif ( 'group' === $item[0] ) {

[236] Fix | Delete

return get_ad_group( absint( $item_id ) );

[237] Fix | Delete

} elseif ( 'placement' === $item[0] ) {

[238] Fix | Delete

return get_ad_placement( $item_id );

[239] Fix | Delete

}

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Get the base id of the widget

[244] Fix | Delete

[245] Fix | Delete

* @return string

[246] Fix | Delete

[247] Fix | Delete

public static function get_base_id() {

[248] Fix | Delete

$options = Advanced_Ads_Plugin::get_instance()->options();

[249] Fix | Delete

[250] Fix | Delete

// deprecated to keep previously changed prefixed working.

[251] Fix | Delete

$prefix2 = ( isset( $options['id-prefix'] ) && '' !== $options['id-prefix'] ) ? $options['id-prefix'] : 'advads_ad_';

[252] Fix | Delete

return $prefix2 . 'widget';

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Get frontend widget id.

[257] Fix | Delete

[258] Fix | Delete

* @param int $number Unique ID number of the current widget instance.

[259] Fix | Delete

* @return string

[260] Fix | Delete

[261] Fix | Delete

private function get_frontend_id( $number ) {

[262] Fix | Delete

$prefix = Advanced_Ads_Plugin::get_instance()->get_frontend_prefix();

[263] Fix | Delete

return $prefix . 'widget-' . $number;

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

/**

[267] Fix | Delete

* Make it harder for ad blockers to block the widget.

[268] Fix | Delete

* removes the pre-defined widget ID (e.g., advads_ad_widget-20) and replaces it with one that uses the individual frontend prefix

[269] Fix | Delete

[270] Fix | Delete

* @param string $before_widget content before the widget.

[271] Fix | Delete

* @param array $instance Settings for the current widget instance.

[272] Fix | Delete

* @return string $before_widget

[273] Fix | Delete

[274] Fix | Delete

private function maybe_replace_frontend_id( $before_widget, $instance ) {

[275] Fix | Delete

if ( ! empty( $instance['remove-widget-id'] )

[276] Fix | Delete

|| defined( 'JNEWS_THEME_ID' ) // the JNews theme overrides the widget ID and resets it, so we target this specifically.

[277] Fix | Delete

) {

[278] Fix | Delete

$pattern = '#\sid=("|\')[^"\']+["\']#';

[279] Fix | Delete

if ( ( defined( 'ADVANCED_ADS_SHOW_WIDGET_ID' ) && ADVANCED_ADS_SHOW_WIDGET_ID )

[280] Fix | Delete

|| ! empty( $instance['q2w3_fixed_widget'] )

[281] Fix | Delete

) {

[282] Fix | Delete

// Replace id.

[283] Fix | Delete

$number = ! empty( $this->number ) ? $this->number : '';

[284] Fix | Delete

$before_widget = preg_replace( $pattern, ' id=$01' . $this->get_frontend_id( $number ) . '$01', $before_widget );

[285] Fix | Delete

} else {

[286] Fix | Delete

// Remove id.

[287] Fix | Delete

$before_widget = preg_replace( $pattern, '', $before_widget );

[288] Fix | Delete

}

[289] Fix | Delete

}

[290] Fix | Delete

return $before_widget;

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

/**

[294] Fix | Delete

* Provide the 'Q2W3 Fixed Widget' plugin with the new frontend widget id.

[295] Fix | Delete

[296] Fix | Delete

* @param array $sidebars_widgets existing sidebar widgets.

[297] Fix | Delete

* @return array $sidebars_widgets

[298] Fix | Delete

[299] Fix | Delete

public function q2w3_replace_frontend_id( $sidebars_widgets ) {

[300] Fix | Delete

foreach ( $sidebars_widgets as $sidebar => $widgets ) {

[301] Fix | Delete

foreach ( $widgets as $k => $widget ) {

[302] Fix | Delete

// after Fixed Widget 5.3.0, the widget option includes '#'. It didn’t before. We store the information since we need it later again.

[303] Fix | Delete

$has_hash = strpos( $widget, '#' ) !== false;

[304] Fix | Delete

$widget = str_replace( '#', '', $widget );

[305] Fix | Delete

$pos = strrpos( $widget, '-' );

[306] Fix | Delete

$option_name = substr( $widget, 0, $pos );

[307] Fix | Delete

$number = substr( $widget, $pos + 1 );

[308] Fix | Delete

[309] Fix | Delete

if ( self::get_base_id() === $option_name ) {

[310] Fix | Delete

$widget_options = get_option( 'widget_' . $option_name );

[311] Fix | Delete

if ( ! empty( $widget_options[ $number ]['remove-widget-id'] ) ) {

[312] Fix | Delete

// add a hash if the widget had one before. See comment above

[313] Fix | Delete

$sidebars_widgets[ $sidebar ][ $k ] = $has_hash ? ( '#' . $this->get_frontend_id( $number ) ) : $this->get_frontend_id( $number );

[314] Fix | Delete

}

[315] Fix | Delete

}

[316] Fix | Delete

}

[317] Fix | Delete

}

[318] Fix | Delete

return $sidebars_widgets;

[319] Fix | Delete

}

[320] Fix | Delete

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete