| 1 |
<?php |
| 2 |
/** |
| 3 |
* Advanced Ads Widget |
| 4 |
* |
| 5 |
* @package Advanced_Ads_Widget |
| 6 |
* @author Thomas Maier <support@wpadvancedads.com> |
| 7 |
* @license GPL-2.0+ |
| 8 |
* @link https://wpadvancedads.com |
| 9 |
* @copyright 2014 Thomas Maier, Advanced Ads GmbH |
| 10 |
*/ |
| 11 |
|
| 12 |
/** |
| 13 |
* Ad widget |
| 14 |
*/ |
| 15 |
class Advanced_Ads_Widget extends WP_Widget { |
| 16 |
|
| 17 |
/** |
| 18 |
* Allows the REST API to see the widgets instance. |
| 19 |
* |
| 20 |
* @deprecated deprecated since WordPress version 5.8 |
| 21 |
* @var bool |
| 22 |
*/ |
| 23 |
public $show_instance_in_rest = true; |
| 24 |
|
| 25 |
/** |
| 26 |
* Advanced_Ads_Widget constructor. |
| 27 |
*/ |
| 28 |
public function __construct() { |
| 29 |
$prefix = Advanced_Ads_Plugin::get_instance()->get_frontend_prefix(); |
| 30 |
$classname = $prefix . 'widget'; |
| 31 |
|
| 32 |
$widget_ops = [ |
| 33 |
'classname' => $classname, |
| 34 |
'show_instance_in_rest' => true, |
| 35 |
'description' => __( 'Display Ads and Ad Groups.', 'advanced-ads' ), |
| 36 |
]; |
| 37 |
$control_ops = []; |
| 38 |
$base_id = self::get_base_id(); |
| 39 |
|
| 40 |
parent::__construct( $base_id, 'Advanced Ads', $widget_ops, $control_ops ); |
| 41 |
|
| 42 |
add_filter( 'q2w3-fixed-widgets', [ $this, 'q2w3_replace_frontend_id' ] ); |
| 43 |
} |
| 44 |
|
| 45 |
/** |
| 46 |
* Echoes the widget content. |
| 47 |
* |
| 48 |
* @param array $args Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'. |
| 49 |
* @param array $instance The settings for the particular instance of the widget. |
| 50 |
*/ |
| 51 |
public function widget( $args, $instance ) { |
| 52 |
/** This filter is documented in wp-includes/default-widgets.php */ |
| 53 |
$title = apply_filters( 'widget_title', empty( $instance['title'] ) ? '' : $instance['title'], $instance, $this->id_base ); |
| 54 |
|
| 55 |
$item_id = empty( $instance['item_id'] ) ? '' : $instance['item_id']; |
| 56 |
|
| 57 |
$output = self::output( $item_id ); |
| 58 |
if ( ! $output ) { |
| 59 |
return; |
| 60 |
} |
| 61 |
|
| 62 |
$before_widget = isset( $args['before_widget'] ) ? $args['before_widget'] : ''; |
| 63 |
$after_widget = isset( $args['after_widget'] ) ? $args['after_widget'] : ''; |
| 64 |
|
| 65 |
$before_widget = $this->maybe_replace_frontend_id( $before_widget, $instance ); |
| 66 |
|
| 67 |
echo $before_widget; |
| 68 |
if ( ! empty( $title ) ) { |
| 69 |
echo $args['before_title'] . $title . $args['after_title']; |
| 70 |
} |
| 71 |
echo $output; |
| 72 |
echo $after_widget; |
| 73 |
} |
| 74 |
|
| 75 |
/** |
| 76 |
* Updates a particular instance of a widget. |
| 77 |
* |
| 78 |
* This function should check that `$new_instance` is set correctly. The newly-calculated |
| 79 |
* value of `$instance` should be returned. If false is returned, the instance won't be |
| 80 |
* saved/updated. |
| 81 |
* |
| 82 |
* @param array $new_instance New settings for this instance as input by the user via WP_Widget::form(). |
| 83 |
* @param array $old_instance Old settings for this instance. |
| 84 |
* @return array Settings to save or bool false to cancel saving. |
| 85 |
*/ |
| 86 |
public function update( $new_instance, $old_instance ) { |
| 87 |
$instance = $old_instance; |
| 88 |
$instance['title'] = $new_instance['title']; |
| 89 |
$instance['item_id'] = $new_instance['item_id']; |
| 90 |
|
| 91 |
// Allow to remove/replace id for new widgets and if it was allowed earlier. |
| 92 |
if ( [] === $old_instance || ! empty( $old_instance['remove-widget-id'] ) ) { |
| 93 |
$instance['remove-widget-id'] = true; |
| 94 |
} |
| 95 |
return $instance; |
| 96 |
} |
| 97 |
|
| 98 |
/** |
| 99 |
* Outputs the settings update form. |
| 100 |
* |
| 101 |
* @param array $instance Current settings. |
| 102 |
*/ |
| 103 |
public function form( $instance ) { |
| 104 |
$instance = wp_parse_args( |
| 105 |
(array) $instance, |
| 106 |
[ |
| 107 |
'title' => '', |
| 108 |
'item_id' => '', |
| 109 |
] |
| 110 |
); |
| 111 |
$title = strip_tags( $instance['title'] ); |
| 112 |
$elementid = $instance['item_id']; |
| 113 |
|
| 114 |
?><p><label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'advanced-ads' ); ?></label> |
| 115 |
<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 |
<?php |
| 117 |
$items = array_merge( self::items_for_select(), self::widget_placements_for_select() ); |
| 118 |
?> |
| 119 |
<select id="<?php echo esc_attr( $this->get_field_id( 'item_id' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'item_id' ) ); ?>"> |
| 120 |
<option value=""><?php esc_html_e( '--empty--', 'advanced-ads' ); ?></option> |
| 121 |
<?php if ( isset( $items['placements'] ) ) : ?> |
| 122 |
<optgroup label="<?php esc_html_e( 'Placements', 'advanced-ads' ); ?>"> |
| 123 |
<?php foreach ( $items['placements'] as $_item_id => $_item_title ) : ?> |
| 124 |
<option value="<?php echo esc_attr( $_item_id ); ?>" <?php selected( $_item_id, $elementid ); ?>><?php echo esc_attr( $_item_title ); ?></option> |
| 125 |
<?php endforeach; ?> |
| 126 |
</optgroup> |
| 127 |
<?php endif; ?> |
| 128 |
<?php if ( isset( $items['groups'] ) ) : ?> |
| 129 |
<optgroup label="<?php esc_html_e( 'Ad Groups', 'advanced-ads' ); ?>"> |
| 130 |
<?php foreach ( $items['groups'] as $_item_id => $_item_title ) : ?> |
| 131 |
<option value="<?php echo esc_attr( $_item_id ); ?>" <?php selected( $_item_id, $elementid ); ?>><?php echo esc_html( $_item_title ); ?></option> |
| 132 |
<?php endforeach; ?> |
| 133 |
</optgroup> |
| 134 |
<?php endif; ?> |
| 135 |
<?php if ( isset( $items['ads'] ) ) : ?> |
| 136 |
<optgroup label="<?php esc_html_e( 'Ads', 'advanced-ads' ); ?>"> |
| 137 |
<?php foreach ( $items['ads'] as $_item_id => $_item_title ) : ?> |
| 138 |
<option value="<?php echo esc_attr( $_item_id ); ?>" <?php selected( $_item_id, $elementid ); ?>><?php echo esc_html( $_item_title ); ?></option> |
| 139 |
<?php endforeach; ?> |
| 140 |
</optgroup> |
| 141 |
<?php endif; ?> |
| 142 |
</select> |
| 143 |
|
| 144 |
<?php |
| 145 |
$this->display_hints( $elementid ); |
| 146 |
} |
| 147 |
|
| 148 |
/** |
| 149 |
* Display hints related to the currently selected item in the dropdown. |
| 150 |
* |
| 151 |
* @param string $elementid Currently selected item. |
| 152 |
*/ |
| 153 |
private function display_hints( $elementid ) { |
| 154 |
$elementid_parts = explode( '_', $elementid ); |
| 155 |
if ( ! isset( $elementid_parts[1] ) || $elementid_parts[0] !== 'group' ) { |
| 156 |
return; |
| 157 |
} |
| 158 |
|
| 159 |
$hints = Advanced_Ads_Group::get_hints( new Advanced_Ads_Group( $elementid_parts[1] ) ); |
| 160 |
require ADVADS_BASE_PATH . 'admin/views/group-hints.php'; |
| 161 |
} |
| 162 |
|
| 163 |
/** |
| 164 |
* Get items for widget select field |
| 165 |
* |
| 166 |
* @return array $select items for select field. |
| 167 |
*/ |
| 168 |
public static function items_for_select() { |
| 169 |
$select = []; |
| 170 |
$model = Advanced_Ads::get_instance()->get_model(); |
| 171 |
|
| 172 |
// load all ads. |
| 173 |
$ads = $model->get_ads( |
| 174 |
[ |
| 175 |
'orderby' => 'title', |
| 176 |
'order' => 'ASC', |
| 177 |
] |
| 178 |
); |
| 179 |
foreach ( $ads as $_ad ) { |
| 180 |
$select['ads'][ 'ad_' . $_ad->ID ] = $_ad->post_title; |
| 181 |
} |
| 182 |
|
| 183 |
// load all ad groups. |
| 184 |
$groups = $model->get_ad_groups(); |
| 185 |
foreach ( $groups as $_group ) { |
| 186 |
$select['groups'][ 'group_' . $_group->term_id ] = $_group->name; |
| 187 |
} |
| 188 |
|
| 189 |
return $select; |
| 190 |
} |
| 191 |
|
| 192 |
/** |
| 193 |
* Get widget placements for select field |
| 194 |
* |
| 195 |
* @return array $items for select field. |
| 196 |
*/ |
| 197 |
public static function widget_placements_for_select() { |
| 198 |
$select = []; |
| 199 |
$placements = Advanced_Ads::get_instance()->get_model()->get_ad_placements_array(); |
| 200 |
|
| 201 |
if ( is_array( $placements ) ) { |
| 202 |
ksort( $placements ); |
| 203 |
} |
| 204 |
|
| 205 |
foreach ( $placements as $placement_slug => $placement ) { |
| 206 |
if ( isset( $placement['type'] ) && in_array( $placement['type'], [ 'sidebar_widget', 'default' ], true ) ) { |
| 207 |
$select['placements'][ 'placement_' . $placement_slug ] = $placement['name']; |
| 208 |
} |
| 209 |
} |
| 210 |
|
| 211 |
return $select; |
| 212 |
} |
| 213 |
|
| 214 |
/** |
| 215 |
* Return content of an in a widget |
| 216 |
* |
| 217 |
* @param string $id slug of the display. |
| 218 |
* @return bool|string |
| 219 |
*/ |
| 220 |
public static function output( $id = '' ) { |
| 221 |
// get placement data for the slug. |
| 222 |
if ( empty( $id ) ) { |
| 223 |
return; } |
| 224 |
|
| 225 |
$item = explode( '_', $id, 2 ); |
| 226 |
|
| 227 |
if ( isset( $item[1] ) ) { |
| 228 |
$item_id = $item[1]; |
| 229 |
} elseif ( empty( $item_id ) ) { |
| 230 |
return; |
| 231 |
} |
| 232 |
|
| 233 |
// return either ad or group content. |
| 234 |
if ( 'ad' === $item[0] ) { |
| 235 |
return get_ad( absint( $item_id ) ); |
| 236 |
} elseif ( 'group' === $item[0] ) { |
| 237 |
return get_ad_group( absint( $item_id ) ); |
| 238 |
} elseif ( 'placement' === $item[0] ) { |
| 239 |
return get_ad_placement( $item_id ); |
| 240 |
} |
| 241 |
} |
| 242 |
|
| 243 |
/** |
| 244 |
* Get the base id of the widget |
| 245 |
* |
| 246 |
* @return string |
| 247 |
*/ |
| 248 |
public static function get_base_id() { |
| 249 |
$options = Advanced_Ads_Plugin::get_instance()->options(); |
| 250 |
|
| 251 |
// deprecated to keep previously changed prefixed working. |
| 252 |
$prefix2 = ( isset( $options['id-prefix'] ) && '' !== $options['id-prefix'] ) ? $options['id-prefix'] : 'advads_ad_'; |
| 253 |
return $prefix2 . 'widget'; |
| 254 |
} |
| 255 |
|
| 256 |
/** |
| 257 |
* Get frontend widget id. |
| 258 |
* |
| 259 |
* @param int $number Unique ID number of the current widget instance. |
| 260 |
* @return string |
| 261 |
*/ |
| 262 |
private function get_frontend_id( $number ) { |
| 263 |
$prefix = Advanced_Ads_Plugin::get_instance()->get_frontend_prefix(); |
| 264 |
return $prefix . 'widget-' . $number; |
| 265 |
} |
| 266 |
|
| 267 |
/** |
| 268 |
* Make it harder for ad blockers to block the widget. |
| 269 |
* removes the pre-defined widget ID (e.g., advads_ad_widget-20) and replaces it with one that uses the individual frontend prefix |
| 270 |
* |
| 271 |
* @param string $before_widget content before the widget. |
| 272 |
* @param array $instance Settings for the current widget instance. |
| 273 |
* @return string $before_widget |
| 274 |
*/ |
| 275 |
private function maybe_replace_frontend_id( $before_widget, $instance ) { |
| 276 |
if ( ! empty( $instance['remove-widget-id'] ) |
| 277 |
|| defined( 'JNEWS_THEME_ID' ) // the JNews theme overrides the widget ID and resets it, so we target this specifically. |
| 278 |
) { |
| 279 |
$pattern = '#\sid=("|\')[^"\']+["\']#'; |
| 280 |
if ( ( defined( 'ADVANCED_ADS_SHOW_WIDGET_ID' ) && ADVANCED_ADS_SHOW_WIDGET_ID ) |
| 281 |
|| ! empty( $instance['q2w3_fixed_widget'] ) |
| 282 |
) { |
| 283 |
// Replace id. |
| 284 |
$number = ! empty( $this->number ) ? $this->number : ''; |
| 285 |
$before_widget = preg_replace( $pattern, ' id=$01' . $this->get_frontend_id( $number ) . '$01', $before_widget ); |
| 286 |
} else { |
| 287 |
// Remove id. |
| 288 |
$before_widget = preg_replace( $pattern, '', $before_widget ); |
| 289 |
} |
| 290 |
} |
| 291 |
return $before_widget; |
| 292 |
} |
| 293 |
|
| 294 |
/** |
| 295 |
* Provide the 'Q2W3 Fixed Widget' plugin with the new frontend widget id. |
| 296 |
* |
| 297 |
* @param array $sidebars_widgets existing sidebar widgets. |
| 298 |
* @return array $sidebars_widgets |
| 299 |
*/ |
| 300 |
public function q2w3_replace_frontend_id( $sidebars_widgets ) { |
| 301 |
foreach ( $sidebars_widgets as $sidebar => $widgets ) { |
| 302 |
foreach ( $widgets as $k => $widget ) { |
| 303 |
// after Fixed Widget 5.3.0, the widget option includes '#'. It didn’t before. We store the information since we need it later again. |
| 304 |
$has_hash = strpos( $widget, '#' ) !== false; |
| 305 |
$widget = str_replace( '#', '', $widget ); |
| 306 |
$pos = strrpos( $widget, '-' ); |
| 307 |
$option_name = substr( $widget, 0, $pos ); |
| 308 |
$number = substr( $widget, $pos + 1 ); |
| 309 |
|
| 310 |
if ( self::get_base_id() === $option_name ) { |
| 311 |
$widget_options = get_option( 'widget_' . $option_name ); |
| 312 |
if ( ! empty( $widget_options[ $number ]['remove-widget-id'] ) ) { |
| 313 |
// add a hash if the widget had one before. See comment above |
| 314 |
$sidebars_widgets[ $sidebar ][ $k ] = $has_hash ? ( '#' . $this->get_frontend_id( $number ) ) : $this->get_frontend_id( $number ); |
| 315 |
} |
| 316 |
} |
| 317 |
} |
| 318 |
} |
| 319 |
return $sidebars_widgets; |
| 320 |
} |
| 321 |
|
| 322 |
} |
| 323 |
|
