networks
5 years ago
class-wordads-admin.php
2 years ago
class-wordads-api.php
4 years ago
class-wordads-array-utils.php
2 years ago
class-wordads-california-privacy.php
3 years ago
class-wordads-ccpa-do-not-sell-link-widget.php
3 years ago
class-wordads-consent-management-provider.php
2 years ago
class-wordads-cron.php
5 years ago
class-wordads-params.php
1 year ago
class-wordads-shortcode.php
1 year ago
class-wordads-sidebar-widget.php
1 year ago
class-wordads-smart.php
1 year ago
class-wordads-sidebar-widget.php
222 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Widget for adding ads to a sidebar. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | /** |
| 9 | * Widget for inserting an ad into your sidebar |
| 10 | * |
| 11 | * @since 4.5.0 |
| 12 | */ |
| 13 | class WordAds_Sidebar_Widget extends WP_Widget { |
| 14 | |
| 15 | /** |
| 16 | * Allowed tags. |
| 17 | * |
| 18 | * @var string[] |
| 19 | */ |
| 20 | private static $allowed_tags = array( 'mrec', 'wideskyscraper', 'leaderboard' ); |
| 21 | |
| 22 | /** |
| 23 | * Mapping array of widget sizes with the WordAds_Smart formats. |
| 24 | * |
| 25 | * @var string[] |
| 26 | */ |
| 27 | private static $sizes_x_smart_format = array( |
| 28 | '300x250' => 'sidebar_widget_mediumrectangle', |
| 29 | '728x90' => 'sidebar_widget_leaderboard', |
| 30 | '160x600' => 'sidebar_widget_wideskyscraper', |
| 31 | ); |
| 32 | |
| 33 | /** |
| 34 | * Number of widgets. |
| 35 | * |
| 36 | * @var int |
| 37 | */ |
| 38 | private static $num_widgets = 0; |
| 39 | |
| 40 | /** |
| 41 | * WordAds_Sidebar_Widget constructor. |
| 42 | */ |
| 43 | public function __construct() { |
| 44 | parent::__construct( |
| 45 | 'wordads_sidebar_widget', |
| 46 | /** This filter is documented in modules/widgets/facebook-likebox.php */ |
| 47 | apply_filters( 'jetpack_widget_name', 'Ads' ), |
| 48 | array( |
| 49 | 'description' => __( 'Insert an ad unit wherever you can place a widget.', 'jetpack' ), |
| 50 | 'customize_selective_refresh' => true, |
| 51 | ) |
| 52 | ); |
| 53 | |
| 54 | add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) ); |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * Remove the Ad widget from the Legacy Widget block |
| 59 | * |
| 60 | * @param array $widget_types List of widgets that are currently removed from the Legacy Widget block. |
| 61 | * |
| 62 | * @return array $widget_types New list of widgets that will be removed. |
| 63 | */ |
| 64 | public function hide_widget_in_block_editor( $widget_types ) { |
| 65 | $widget_types[] = 'wordads_sidebar_widget'; |
| 66 | return $widget_types; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * The Widget outputter. |
| 71 | * |
| 72 | * @param array $args Widget args. |
| 73 | * @param array $instance The Widget instance. |
| 74 | * |
| 75 | * @return bool|void |
| 76 | */ |
| 77 | public function widget( $args, $instance ) { |
| 78 | global $wordads; |
| 79 | if ( $wordads->should_bail() ) { |
| 80 | return false; |
| 81 | } |
| 82 | |
| 83 | if ( ! isset( $instance['unit'] ) ) { |
| 84 | $instance['unit'] = 'mrec'; |
| 85 | } |
| 86 | |
| 87 | ++self::$num_widgets; |
| 88 | $width = WordAds::$ad_tag_ids[ $instance['unit'] ]['width']; |
| 89 | $height = WordAds::$ad_tag_ids[ $instance['unit'] ]['height']; |
| 90 | $unit_id = 1 === self::$num_widgets ? 3 : self::$num_widgets + 3; // 2nd belowpost is '4' |
| 91 | $section_id = 0 === $wordads->params->blog_id ? |
| 92 | WORDADS_API_TEST_ID : |
| 93 | $wordads->params->blog_id . $unit_id; |
| 94 | |
| 95 | $smart_format = self::$sizes_x_smart_format[ "{$width}x{$height}" ]; |
| 96 | // phpcs:disable WordPress.Security.NonceVerification.Recommended |
| 97 | $is_watl_enabled = isset( $_GET['wordads-logging'] ) && isset( $_GET[ $smart_format ] ) && 'true' === $_GET[ $smart_format ]; |
| 98 | |
| 99 | // Get the widget snippet. |
| 100 | $widget_snippet = $this->get_widget_snippet( $instance, $section_id, $height, $width ); |
| 101 | |
| 102 | // Render the IPW or house ad if WATL is disabled. |
| 103 | if ( ! $is_watl_enabled ) { |
| 104 | // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 105 | echo $widget_snippet; |
| 106 | return; |
| 107 | } |
| 108 | |
| 109 | // Remove linebreaks and sanitize. |
| 110 | $tag = esc_js( str_replace( array( "\n", "\t", "\r" ), '', $widget_snippet ) ); |
| 111 | |
| 112 | // Add the fallback to be processed by WATL. |
| 113 | $fallback_snippet = <<<HTML |
| 114 | <script type="text/javascript"> |
| 115 | var sas_fallback = sas_fallback || []; |
| 116 | sas_fallback.push( |
| 117 | { tag: "$tag", type: '$smart_format' } |
| 118 | ); |
| 119 | </script> |
| 120 | HTML; |
| 121 | |
| 122 | // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 123 | echo $fallback_snippet . $wordads::get_watl_ad_html_tag( $smart_format ); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * The widget snippet. |
| 128 | * |
| 129 | * @param array $instance The widget instance. |
| 130 | * @param string $section_id The section id. |
| 131 | * @param int $height The ad height. |
| 132 | * @param int $width The ad width. |
| 133 | * |
| 134 | * @return string |
| 135 | */ |
| 136 | private function get_widget_snippet( $instance, $section_id, $height, $width ) { |
| 137 | global $wordads; |
| 138 | |
| 139 | if ( $wordads->option( 'wordads_house', true ) ) { |
| 140 | $unit = 'mrec'; |
| 141 | if ( 'leaderboard' === $instance['unit'] && ! $this->params->mobile_device ) { |
| 142 | $unit = 'leaderboard'; |
| 143 | } elseif ( 'wideskyscraper' === $instance['unit'] ) { |
| 144 | $unit = 'widesky'; |
| 145 | } |
| 146 | |
| 147 | $snippet = $wordads->get_house_ad( $unit ); |
| 148 | } else { |
| 149 | return $wordads->get_ad_snippet( $section_id, $height, $width, 'widget' ); |
| 150 | } |
| 151 | |
| 152 | $about = __( 'Advertisements', 'jetpack' ); |
| 153 | $unit = esc_attr( $instance['unit'] ); |
| 154 | |
| 155 | return <<<HTML |
| 156 | <div class="wpcnt"> |
| 157 | <div class="wpa"> |
| 158 | <span class="wpa-about">$about</span> |
| 159 | <div class="u $unit"> |
| 160 | $snippet |
| 161 | </div> |
| 162 | </div> |
| 163 | </div> |
| 164 | HTML; |
| 165 | } |
| 166 | |
| 167 | /** |
| 168 | * The widget settings form. |
| 169 | * |
| 170 | * @param array $instance Widget instance. |
| 171 | * |
| 172 | * @return string|void |
| 173 | */ |
| 174 | public function form( $instance ) { |
| 175 | // ad unit type. |
| 176 | if ( isset( $instance['unit'] ) ) { |
| 177 | $unit = $instance['unit']; |
| 178 | } else { |
| 179 | $unit = 'mrec'; |
| 180 | } |
| 181 | ?> |
| 182 | <p> |
| 183 | <label for="<?php echo esc_attr( $this->get_field_id( 'unit' ) ); ?>"><?php esc_html_e( 'Tag Dimensions:', 'jetpack' ); ?></label> |
| 184 | <select class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'unit' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'unit' ) ); ?>"> |
| 185 | <?php |
| 186 | foreach ( WordAds::$ad_tag_ids as $ad_unit => $properties ) { |
| 187 | if ( ! in_array( $ad_unit, self::$allowed_tags, true ) ) { |
| 188 | continue; |
| 189 | } |
| 190 | |
| 191 | $splits = explode( '_', $properties['tag'] ); |
| 192 | $unit_pretty = "{$splits[0]} {$splits[1]}"; |
| 193 | $selected = selected( $ad_unit, $unit, false ); |
| 194 | echo "<option value='", esc_attr( $ad_unit ), "' ", esc_attr( $selected ), '>', esc_html( $unit_pretty ), '</option>'; |
| 195 | } |
| 196 | ?> |
| 197 | </select> |
| 198 | </p> |
| 199 | <?php |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * The Widget updater. |
| 204 | * |
| 205 | * @param array $new_instance The revised instance. |
| 206 | * @param array $old_instance Original instance. |
| 207 | * |
| 208 | * @return array |
| 209 | */ |
| 210 | public function update( $new_instance, $old_instance ) { |
| 211 | $instance = $old_instance; |
| 212 | |
| 213 | if ( in_array( $new_instance['unit'], self::$allowed_tags, true ) ) { |
| 214 | $instance['unit'] = $new_instance['unit']; |
| 215 | } else { |
| 216 | $instance['unit'] = 'mrec'; |
| 217 | } |
| 218 | |
| 219 | return $instance; |
| 220 | } |
| 221 | } |
| 222 |