Edit File by line
/home/zeestwma/richards.../wp-conte.../plugins/jetpack/modules/wordads/php
File: class-wordads-smart.php
<?php
[0] Fix | Delete
/**
[1] Fix | Delete
* An implementation for ads served through Equativ Smart Ad Server.
[2] Fix | Delete
*
[3] Fix | Delete
* @package automattic/jetpack
[4] Fix | Delete
*/
[5] Fix | Delete
[6] Fix | Delete
use Automattic\Jetpack\Assets;
[7] Fix | Delete
[8] Fix | Delete
if ( ! defined( 'ABSPATH' ) ) {
[9] Fix | Delete
exit( 0 );
[10] Fix | Delete
}
[11] Fix | Delete
[12] Fix | Delete
// phpcs:disable WordPress.WP.EnqueuedResources.NonEnqueuedScript
[13] Fix | Delete
[14] Fix | Delete
require_once WORDADS_ROOT . '/php/class-wordads-array-utils.php';
[15] Fix | Delete
[16] Fix | Delete
/**
[17] Fix | Delete
* Contains all the implementation details for Smart ads
[18] Fix | Delete
*/
[19] Fix | Delete
class WordAds_Smart {
[20] Fix | Delete
[21] Fix | Delete
/**
[22] Fix | Delete
* The single instance of the class.
[23] Fix | Delete
*
[24] Fix | Delete
* @var WordAds_Smart
[25] Fix | Delete
*/
[26] Fix | Delete
protected static $instance = null;
[27] Fix | Delete
[28] Fix | Delete
/**
[29] Fix | Delete
* The parameters for WordAds.
[30] Fix | Delete
*
[31] Fix | Delete
* @var WordAds_Params
[32] Fix | Delete
*/
[33] Fix | Delete
private $params;
[34] Fix | Delete
[35] Fix | Delete
/**
[36] Fix | Delete
* Has Smart asset been enqueued?
[37] Fix | Delete
*
[38] Fix | Delete
* @var bool True if Smart asset has been enqueued.
[39] Fix | Delete
*/
[40] Fix | Delete
private $is_asset_enqueued = false;
[41] Fix | Delete
[42] Fix | Delete
/**
[43] Fix | Delete
* Supported formats.
[44] Fix | Delete
* sidebar_widget formats represents the legacy Jetpack sidebar widget.
[45] Fix | Delete
*
[46] Fix | Delete
* @var array
[47] Fix | Delete
*/
[48] Fix | Delete
private $formats = array(
[49] Fix | Delete
'top' => array(
[50] Fix | Delete
'enabled' => false,
[51] Fix | Delete
),
[52] Fix | Delete
'inline' => array(
[53] Fix | Delete
'enabled' => false,
[54] Fix | Delete
),
[55] Fix | Delete
'belowpost' => array(
[56] Fix | Delete
'enabled' => false,
[57] Fix | Delete
),
[58] Fix | Delete
'bottom_sticky' => array(
[59] Fix | Delete
'enabled' => false,
[60] Fix | Delete
),
[61] Fix | Delete
'sidebar_sticky_right' => array(
[62] Fix | Delete
'enabled' => false,
[63] Fix | Delete
),
[64] Fix | Delete
'gutenberg_rectangle' => array(
[65] Fix | Delete
'enabled' => false,
[66] Fix | Delete
),
[67] Fix | Delete
'gutenberg_leaderboard' => array(
[68] Fix | Delete
'enabled' => false,
[69] Fix | Delete
),
[70] Fix | Delete
'gutenberg_mobile_leaderboard' => array(
[71] Fix | Delete
'enabled' => false,
[72] Fix | Delete
),
[73] Fix | Delete
'gutenberg_skyscraper' => array(
[74] Fix | Delete
'enabled' => false,
[75] Fix | Delete
),
[76] Fix | Delete
'sidebar_widget_mediumrectangle' => array(
[77] Fix | Delete
'enabled' => false,
[78] Fix | Delete
),
[79] Fix | Delete
'sidebar_widget_leaderboard' => array(
[80] Fix | Delete
'enabled' => false,
[81] Fix | Delete
),
[82] Fix | Delete
'sidebar_widget_wideskyscraper' => array(
[83] Fix | Delete
'enabled' => false,
[84] Fix | Delete
),
[85] Fix | Delete
'shortcode' => array(
[86] Fix | Delete
'enabled' => false,
[87] Fix | Delete
),
[88] Fix | Delete
);
[89] Fix | Delete
[90] Fix | Delete
/**
[91] Fix | Delete
* Private constructor.
[92] Fix | Delete
*/
[93] Fix | Delete
private function __construct() {
[94] Fix | Delete
}
[95] Fix | Delete
[96] Fix | Delete
/**
[97] Fix | Delete
* Main Class Instance.
[98] Fix | Delete
*
[99] Fix | Delete
* Ensures only one instance of WordAds_Smart is loaded or can be loaded.
[100] Fix | Delete
*
[101] Fix | Delete
* @return WordAds_Smart
[102] Fix | Delete
*/
[103] Fix | Delete
public static function instance(): self {
[104] Fix | Delete
if ( null === self::$instance ) {
[105] Fix | Delete
self::$instance = new self();
[106] Fix | Delete
}
[107] Fix | Delete
return self::$instance;
[108] Fix | Delete
}
[109] Fix | Delete
[110] Fix | Delete
/**
[111] Fix | Delete
* Initialize the ads.
[112] Fix | Delete
*
[113] Fix | Delete
* @param WordAds_Params $params Object containing WordAds settings.
[114] Fix | Delete
*
[115] Fix | Delete
* @return void
[116] Fix | Delete
*/
[117] Fix | Delete
public function init( WordAds_Params $params ) {
[118] Fix | Delete
$this->params = $params;
[119] Fix | Delete
[120] Fix | Delete
$this->enable_formats();
[121] Fix | Delete
$this->override_formats_from_query_string();
[122] Fix | Delete
[123] Fix | Delete
if ( $this->has_any_format_enabled() ) {
[124] Fix | Delete
$this->insert_ads();
[125] Fix | Delete
}
[126] Fix | Delete
}
[127] Fix | Delete
[128] Fix | Delete
/**
[129] Fix | Delete
* Enqueue any front-end CSS and JS.
[130] Fix | Delete
*
[131] Fix | Delete
* @return void
[132] Fix | Delete
*/
[133] Fix | Delete
public function enqueue_assets() {
[134] Fix | Delete
[135] Fix | Delete
if ( $this->is_asset_enqueued ) {
[136] Fix | Delete
return;
[137] Fix | Delete
}
[138] Fix | Delete
[139] Fix | Delete
add_action( 'wp_head', array( $this, 'insert_config' ) );
[140] Fix | Delete
[141] Fix | Delete
Assets::register_script(
[142] Fix | Delete
'adflow_script_loader',
[143] Fix | Delete
'_inc/build/wordads/js/adflow-loader.min.js',
[144] Fix | Delete
JETPACK__PLUGIN_FILE,
[145] Fix | Delete
array(
[146] Fix | Delete
'nonmin_path' => 'modules/wordads/js/adflow-loader.js',
[147] Fix | Delete
'dependencies' => array(),
[148] Fix | Delete
'enqueue' => true,
[149] Fix | Delete
'version' => JETPACK__VERSION,
[150] Fix | Delete
)
[151] Fix | Delete
);
[152] Fix | Delete
[153] Fix | Delete
wp_enqueue_script(
[154] Fix | Delete
'adflow_config',
[155] Fix | Delete
esc_url( $this->get_config_url() ),
[156] Fix | Delete
array( 'adflow_script_loader' ),
[157] Fix | Delete
JETPACK__VERSION,
[158] Fix | Delete
false
[159] Fix | Delete
);
[160] Fix | Delete
[161] Fix | Delete
$this->is_asset_enqueued = true;
[162] Fix | Delete
}
[163] Fix | Delete
[164] Fix | Delete
/**
[165] Fix | Delete
* Inserts ad tags on the page.
[166] Fix | Delete
*
[167] Fix | Delete
* @return void
[168] Fix | Delete
*/
[169] Fix | Delete
private function insert_ads() {
[170] Fix | Delete
if ( $this->params->is_amp ) {
[171] Fix | Delete
return;
[172] Fix | Delete
}
[173] Fix | Delete
[174] Fix | Delete
// Don't run on not found pages.
[175] Fix | Delete
if ( is_404() ) {
[176] Fix | Delete
return;
[177] Fix | Delete
}
[178] Fix | Delete
[179] Fix | Delete
// Add the resource hints.
[180] Fix | Delete
add_filter( 'wp_resource_hints', array( $this, 'resource_hints' ), 10, 2 );
[181] Fix | Delete
[182] Fix | Delete
// Enqueue JS assets.
[183] Fix | Delete
$this->enqueue_assets();
[184] Fix | Delete
[185] Fix | Delete
$is_static_front_page = is_front_page() && 'page' === get_option( 'show_on_front' );
[186] Fix | Delete
[187] Fix | Delete
if ( ! ( $is_static_front_page || is_home() ) ) {
[188] Fix | Delete
if ( $this->formats['inline']['enabled'] ) {
[189] Fix | Delete
add_filter(
[190] Fix | Delete
'the_content',
[191] Fix | Delete
array( $this, 'insert_inline_marker' ),
[192] Fix | Delete
10
[193] Fix | Delete
);
[194] Fix | Delete
}
[195] Fix | Delete
}
[196] Fix | Delete
[197] Fix | Delete
if ( $this->formats['bottom_sticky']['enabled'] ) {
[198] Fix | Delete
// Disable IPW slot.
[199] Fix | Delete
add_filter( 'wordads_iponweb_bottom_sticky_ad_disable', '__return_true', 10 );
[200] Fix | Delete
}
[201] Fix | Delete
[202] Fix | Delete
if ( $this->formats['sidebar_sticky_right']['enabled'] ) {
[203] Fix | Delete
// Disable IPW slot.
[204] Fix | Delete
add_filter( 'wordads_iponweb_sidebar_sticky_right_ad_disable', '__return_true', 10 );
[205] Fix | Delete
}
[206] Fix | Delete
}
[207] Fix | Delete
[208] Fix | Delete
/**
[209] Fix | Delete
* Inserts JS configuration used by watl.js.
[210] Fix | Delete
*
[211] Fix | Delete
* @return void
[212] Fix | Delete
*/
[213] Fix | Delete
public function insert_config() {
[214] Fix | Delete
global $post;
[215] Fix | Delete
[216] Fix | Delete
$config = array(
[217] Fix | Delete
'post_id' => ( $post instanceof WP_Post ) && is_singular( 'post' ) ? $post->ID : null,
[218] Fix | Delete
'origin' => 'jetpack',
[219] Fix | Delete
'theme' => get_stylesheet(),
[220] Fix | Delete
'target' => $this->target_keywords(),
[221] Fix | Delete
) + $this->formats;
[222] Fix | Delete
[223] Fix | Delete
// Do conversion.
[224] Fix | Delete
$js_config = WordAds_Array_Utils::array_to_js_object( $config );
[225] Fix | Delete
[226] Fix | Delete
// Output script.
[227] Fix | Delete
wp_print_inline_script_tag( "var wa_smart = $js_config; wa_smart.cmd = [];" );
[228] Fix | Delete
}
[229] Fix | Delete
[230] Fix | Delete
/**
[231] Fix | Delete
* Add the Smart resource hints.
[232] Fix | Delete
*
[233] Fix | Delete
* @param array $hints Domains for hinting.
[234] Fix | Delete
* @param string $relation_type Resource type.
[235] Fix | Delete
*
[236] Fix | Delete
* @return array Domains for hinting.
[237] Fix | Delete
*/
[238] Fix | Delete
public function resource_hints( $hints, $relation_type ) {
[239] Fix | Delete
if ( 'dns-prefetch' === $relation_type ) {
[240] Fix | Delete
$hints[] = '//af.pubmine.com';
[241] Fix | Delete
}
[242] Fix | Delete
[243] Fix | Delete
return $hints;
[244] Fix | Delete
}
[245] Fix | Delete
[246] Fix | Delete
/**
[247] Fix | Delete
* Gets the URL to a JSONP endpoint with configuration data.
[248] Fix | Delete
*
[249] Fix | Delete
* @return string The URL.
[250] Fix | Delete
*/
[251] Fix | Delete
private function get_config_url(): string {
[252] Fix | Delete
return sprintf(
[253] Fix | Delete
'https://public-api.wordpress.com/wpcom/v2/sites/%1$d/adflow/conf/?_jsonp=a8c_adflow_callback',
[254] Fix | Delete
$this->params->blog_id
[255] Fix | Delete
);
[256] Fix | Delete
}
[257] Fix | Delete
[258] Fix | Delete
/**
[259] Fix | Delete
* Places marker at the end of the content so inline can identify the post content container.
[260] Fix | Delete
*
[261] Fix | Delete
* @param string|null $content The post content.
[262] Fix | Delete
* @return string|null The post content with the marker appended.
[263] Fix | Delete
*/
[264] Fix | Delete
public function insert_inline_marker( ?string $content ): ?string {
[265] Fix | Delete
if ( null === $content ) {
[266] Fix | Delete
return null;
[267] Fix | Delete
}
[268] Fix | Delete
$inline_ad_marker = '<span id="wordads-inline-marker" style="display: none;"></span>';
[269] Fix | Delete
[270] Fix | Delete
// Append the ad to the post content.
[271] Fix | Delete
return $content . $inline_ad_marker;
[272] Fix | Delete
}
[273] Fix | Delete
[274] Fix | Delete
/**
[275] Fix | Delete
* Gets a formatted list of target keywords.
[276] Fix | Delete
*
[277] Fix | Delete
* @return string Formatted list of target keywords.
[278] Fix | Delete
*/
[279] Fix | Delete
private function target_keywords(): string {
[280] Fix | Delete
$target_keywords = array_merge(
[281] Fix | Delete
$this->get_blog_keywords(),
[282] Fix | Delete
$this->get_language_keywords()
[283] Fix | Delete
);
[284] Fix | Delete
[285] Fix | Delete
return implode( ';', $target_keywords );
[286] Fix | Delete
}
[287] Fix | Delete
[288] Fix | Delete
/**
[289] Fix | Delete
* Gets a formatted list of blog keywords.
[290] Fix | Delete
*
[291] Fix | Delete
* @return array The list of blog keywords.
[292] Fix | Delete
*/
[293] Fix | Delete
private function get_blog_keywords(): array {
[294] Fix | Delete
return array( 'wp_blog_id=' . $this->params->blog_id );
[295] Fix | Delete
}
[296] Fix | Delete
[297] Fix | Delete
/**
[298] Fix | Delete
* Gets the site language formatted as a keyword.
[299] Fix | Delete
*
[300] Fix | Delete
* @return array The language as a keyword.
[301] Fix | Delete
*/
[302] Fix | Delete
private function get_language_keywords(): array {
[303] Fix | Delete
return array( 'language=' . explode( '-', get_locale() )[0] );
[304] Fix | Delete
}
[305] Fix | Delete
[306] Fix | Delete
/**
[307] Fix | Delete
* Enable formats by post types and the display options.
[308] Fix | Delete
*
[309] Fix | Delete
* @return void
[310] Fix | Delete
*/
[311] Fix | Delete
private function enable_formats(): void {
[312] Fix | Delete
$this->formats['top']['enabled'] = $this->params->options['enable_header_ad'];
[313] Fix | Delete
$this->formats['inline']['enabled'] = is_singular( 'post' ) && $this->params->options['wordads_inline_enabled'];
[314] Fix | Delete
$this->formats['belowpost']['enabled'] = $this->params->should_show();
[315] Fix | Delete
$this->formats['bottom_sticky']['enabled'] = $this->params->options['wordads_bottom_sticky_enabled'];
[316] Fix | Delete
$this->formats['sidebar_sticky_right']['enabled'] = $this->params->options['wordads_sidebar_sticky_right_enabled'];
[317] Fix | Delete
}
[318] Fix | Delete
[319] Fix | Delete
/**
[320] Fix | Delete
* Allow format enabled override from query string, eg. ?inline=true.
[321] Fix | Delete
*
[322] Fix | Delete
* @return void
[323] Fix | Delete
*/
[324] Fix | Delete
private function override_formats_from_query_string(): void {
[325] Fix | Delete
// phpcs:disable WordPress.Security.NonceVerification.Recommended
[326] Fix | Delete
if ( ! isset( $_GET['wordads-logging'] ) ) {
[327] Fix | Delete
return;
[328] Fix | Delete
}
[329] Fix | Delete
[330] Fix | Delete
foreach ( $this->formats as $format_type => $_ ) {
[331] Fix | Delete
// phpcs:disable WordPress.Security.NonceVerification.Recommended
[332] Fix | Delete
if ( isset( $_GET[ $format_type ] ) && 'true' === $_GET[ $format_type ] ) {
[333] Fix | Delete
$this->formats[ $format_type ]['enabled'] = true;
[334] Fix | Delete
}
[335] Fix | Delete
}
[336] Fix | Delete
}
[337] Fix | Delete
[338] Fix | Delete
/**
[339] Fix | Delete
* Check if has any format enabled.
[340] Fix | Delete
*
[341] Fix | Delete
* @return bool True if enabled, false otherwise.
[342] Fix | Delete
*/
[343] Fix | Delete
private function has_any_format_enabled(): bool {
[344] Fix | Delete
return in_array( true, array_column( $this->formats, 'enabled' ), true );
[345] Fix | Delete
}
[346] Fix | Delete
}
[347] Fix | Delete
[348] Fix | Delete
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
Function