wordads.php
188 lines
| 1 | <?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 | /** |
| 3 | * Ads Block. |
| 4 | * |
| 5 | * @since 7.1.0 |
| 6 | * |
| 7 | * @package automattic/jetpack |
| 8 | */ |
| 9 | |
| 10 | namespace Automattic\Jetpack\Extensions; |
| 11 | |
| 12 | use Automattic\Jetpack\Blocks; |
| 13 | use Automattic\Jetpack\Current_Plan as Jetpack_Plan; |
| 14 | use Automattic\Jetpack\Modules; |
| 15 | use Automattic\Jetpack\Status\Host; |
| 16 | use Jetpack_Gutenberg; |
| 17 | |
| 18 | /** |
| 19 | * Jetpack's Ads Block class. |
| 20 | * |
| 21 | * @since 7.1.0 |
| 22 | */ |
| 23 | class WordAds { |
| 24 | /** |
| 25 | * Mapping array of gutenberg ad snippet with the WordAds_Smart formats. |
| 26 | * |
| 27 | * @var array |
| 28 | */ |
| 29 | private static $gutenberg_ad_snippet_x_smart_format = array( |
| 30 | 'gutenberg_300x250' => 'gutenberg_rectangle', |
| 31 | 'gutenberg_728x90' => 'gutenberg_leaderboard', |
| 32 | 'gutenberg_320x50' => 'gutenberg_mobile_leaderboard', |
| 33 | 'gutenberg_160x600' => 'gutenberg_skyscraper', |
| 34 | ); |
| 35 | |
| 36 | /** |
| 37 | * Check if site is on WP.com Simple. |
| 38 | * |
| 39 | * @return bool |
| 40 | */ |
| 41 | private static function is_wpcom() { |
| 42 | return ( new Host() )->is_wpcom_simple(); |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * Check if the WordAds module is active. |
| 47 | * |
| 48 | * @return bool |
| 49 | */ |
| 50 | private static function is_jetpack_module_active() { |
| 51 | return ( new Modules() )->is_active( 'wordads' ); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Check if the site is approved for ads for WP.com Simple sites. |
| 56 | * |
| 57 | * @return bool |
| 58 | */ |
| 59 | private static function is_available() { |
| 60 | if ( self::is_wpcom() ) { |
| 61 | return has_any_blog_stickers( array( 'wordads', 'wordads-approved', 'wordads-approved-misfits' ), get_current_blog_id() ); |
| 62 | } |
| 63 | |
| 64 | return Jetpack_Plan::supports( 'wordads' ); |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Register the WordAds block. |
| 69 | */ |
| 70 | public static function register() { |
| 71 | /* |
| 72 | * The block is available even when the module is not active, |
| 73 | * so we can display a nudge to activate the module instead of the block. |
| 74 | * However, since non-admins cannot activate modules, we do not display the empty block for them. |
| 75 | */ |
| 76 | if ( ! self::is_jetpack_module_active() && ! current_user_can( 'jetpack_activate_modules' ) ) { |
| 77 | return; |
| 78 | } |
| 79 | |
| 80 | if ( ! self::is_available() ) { |
| 81 | return; |
| 82 | } |
| 83 | |
| 84 | Blocks::jetpack_register_block( |
| 85 | __DIR__, |
| 86 | array( |
| 87 | 'render_callback' => array( __CLASS__, 'gutenblock_render' ), |
| 88 | ) |
| 89 | ); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Set if the WordAds block is available. |
| 94 | */ |
| 95 | public static function set_availability() { |
| 96 | $block_name = 'wordads'; |
| 97 | |
| 98 | if ( ! self::is_available() ) { |
| 99 | Jetpack_Gutenberg::set_extension_unavailable( $block_name, 'WordAds unavailable' ); |
| 100 | return; |
| 101 | } |
| 102 | // Make the block available. Just in case it wasn't registered before. |
| 103 | Jetpack_Gutenberg::set_extension_available( $block_name ); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Renders the WordAds block. |
| 108 | * |
| 109 | * @param array $attr Block attributes. |
| 110 | * |
| 111 | * @return string Block HTML. |
| 112 | */ |
| 113 | public static function gutenblock_render( $attr ) { |
| 114 | global $wordads; |
| 115 | |
| 116 | /** If the WordAds module is not active, don't render the block. */ |
| 117 | if ( ! self::is_jetpack_module_active() ) { |
| 118 | return ''; |
| 119 | } |
| 120 | |
| 121 | /** This filter is already documented in modules/wordads/class-wordads.php `insert_ad()` */ |
| 122 | if ( |
| 123 | empty( $wordads ) |
| 124 | || empty( $wordads->params ) |
| 125 | || is_feed() |
| 126 | || apply_filters( 'wordads_inpost_disable', false ) |
| 127 | ) { |
| 128 | return ''; |
| 129 | } |
| 130 | |
| 131 | if ( ! empty( $attr['hideMobile'] ) && $wordads->params->is_mobile() ) { |
| 132 | return ''; |
| 133 | } |
| 134 | |
| 135 | if ( ! self::is_wpcom() && $wordads->option( 'wordads_house' ) ) { |
| 136 | return $wordads->get_ad( 'inline', 'house' ); |
| 137 | } |
| 138 | |
| 139 | // section_id is mostly deprecated at this point, but it helps us (devs) keep track of which ads end up where |
| 140 | // 6 is to keep track of gutenblock ads. |
| 141 | $section_id = $wordads->params->blog_id . '6'; |
| 142 | $align = 'center'; |
| 143 | if ( isset( $attr['align'] ) && in_array( $attr['align'], array( 'left', 'center', 'right' ), true ) ) { |
| 144 | $align = $attr['align']; |
| 145 | } |
| 146 | $align = 'align' . $align; |
| 147 | |
| 148 | $ad_tag_ids = $wordads->get_ad_tags(); |
| 149 | $format = 'mrec'; |
| 150 | if ( isset( $attr['format'] ) && isset( $ad_tag_ids[ $attr['format'] ] ) ) { |
| 151 | $format = $attr['format']; |
| 152 | } |
| 153 | |
| 154 | $height = $ad_tag_ids[ $format ]['height']; |
| 155 | $width = $ad_tag_ids[ $format ]['width']; |
| 156 | $location = 'gutenberg'; |
| 157 | $snippet = $wordads->get_ad_snippet( $section_id, $height, $width, $location, $wordads->get_solo_unit_css() ); |
| 158 | |
| 159 | $key = "{$location}_{$width}x{$height}"; |
| 160 | $smart_format = self::$gutenberg_ad_snippet_x_smart_format[ $key ] ?? null; |
| 161 | // phpcs:disable WordPress.Security.NonceVerification.Recommended |
| 162 | $is_watl_enabled = $smart_format && ( isset( $_GET[ $smart_format ] ) && 'true' === $_GET[ $smart_format ] ); |
| 163 | $ad_div = $wordads->get_ad_div( 'inline', $snippet, array( $align ) ); |
| 164 | // Render IPW div if WATL is not enabled. |
| 165 | if ( ! $is_watl_enabled ) { |
| 166 | return $ad_div; |
| 167 | } |
| 168 | |
| 169 | // Remove linebreaks and sanitize. |
| 170 | $snippet = esc_js( str_replace( array( "\n", "\t", "\r" ), '', $ad_div ) ); |
| 171 | |
| 172 | // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped |
| 173 | $fallback_snippet = <<<HTML |
| 174 | <script> |
| 175 | var sas_fallback = sas_fallback || []; |
| 176 | sas_fallback.push( |
| 177 | { tag: "$snippet", type: '$smart_format' } |
| 178 | ); |
| 179 | </script> |
| 180 | HTML; |
| 181 | |
| 182 | return $fallback_snippet . $wordads->get_watl_ad_html_tag( $smart_format ); |
| 183 | } |
| 184 | } |
| 185 | |
| 186 | add_action( 'init', array( 'Automattic\\Jetpack\\Extensions\\WordAds', 'register' ) ); |
| 187 | add_action( 'jetpack_register_gutenberg_extensions', array( 'Automattic\\Jetpack\\Extensions\\WordAds', 'set_availability' ) ); |
| 188 |