: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
use AdvancedAds\Utilities\WordPress;
* Injects ads in the content based on an XPath expression.
class Advanced_Ads_In_Content_Injector {
* Gather placeholders which later are replaced by the ads
* @var array $ads_for_placeholders
private static $ads_for_placeholders = [];
* Inject ads directly into the content
* @param string $placement_id Id of the placement.
* @param array $placement_opts Placement options.
* @param string $content Content to inject placement into.
* @param array $options {
* @type bool $allowEmpty Whether the tag can be empty to be counted.
* @type bool $paragraph_select_from_bottom Whether to select ads from buttom.
* @type string $position Position. Can be one of 'before', 'after', 'append', 'prepend'
* @type number $alter_nodes Whether to alter nodes, for example to prevent injecting ads into `a` tags.
* @type bool $repeat Whether to repeat the position.
* @type number $paragraph_id Paragraph Id.
* @type number $itemLimit If there are too few items at this level test nesting. Set to '-1` to prevent testing.
* @return string $content Content with injected placement.
public static function &inject_in_content( $placement_id, $placement_opts, &$content, $options = [] ) {
if ( ! extension_loaded( 'dom' ) ) {
// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
// phpcs:disable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
$tag = isset( $placement_opts['tag'] ) ? $placement_opts['tag'] : 'p';
$tag = preg_replace( '/[^a-z0-9]/i', '', $tag ); // simplify tag.
* Store the original tag value since $tag is changed on the fly and we might want to know the original selected
* options for some checks later.
// allow more complex xPath expression.
$tag = apply_filters( 'advanced-ads-placement-content-injection-xpath', $tag, $placement_opts );
$plugin_options = Advanced_Ads::get_instance()->options();
'paragraph_select_from_bottom' => isset( $placement_opts['start_from_bottom'] ) && $placement_opts['start_from_bottom'],
'position' => isset( $placement_opts['position'] ) ? $placement_opts['position'] : 'after',
// only has before and after.
'before' => isset( $placement_opts['position'] ) && 'before' === $placement_opts['position'],
// Whether to alter nodes, for example to prevent injecting ads into `a` tags.
$defaults['paragraph_id'] = isset( $placement_opts['index'] ) ? $placement_opts['index'] : 1;
$defaults['paragraph_id'] = max( 1, (int) $defaults['paragraph_id'] );
// if there are too few items at this level test nesting.
$defaults['itemLimit'] = 'p' === $tag_option ? 2 : 1;
// trigger such a high item limit that all elements will be considered.
if ( ! empty( $plugin_options['content-injection-level-disabled'] ) ) {
$defaults['itemLimit'] = 1000;
// handle tags that are empty by definition or could be empty ("custom" option)
if ( in_array( $tag_option, [ 'img', 'iframe', 'custom' ], true ) ) {
$defaults['allowEmpty'] = true;
// allow hooks to change some options.
$options = apply_filters(
'advanced-ads-placement-content-injection-options',
wp_parse_args( $options, $defaults ),
$wp_charset = get_bloginfo( 'charset' );
// parse document as DOM (fragment - having only a part of an actual post given).
$content_to_load = self::get_content_to_load( $content, $wp_charset );
if ( ! $content_to_load ) {
$dom = new DOMDocument( '1.0', $wp_charset );
// may loose some fragments or add autop-like code.
$libxml_use_internal_errors = libxml_use_internal_errors( true ); // avoid notices and warnings - html is most likely malformed.
$success = $dom->loadHtml( '<!DOCTYPE html><html><meta http-equiv="Content-Type" content="text/html; charset=' . $wp_charset . '" /><body>' . $content_to_load );
libxml_use_internal_errors( $libxml_use_internal_errors );
if ( true !== $success ) {
// -TODO handle cases were dom-parsing failed (at least inform user)
// exclude paragraphs within blockquote tags
$tag = 'p[not(parent::blockquote)]';
// convert option name into correct path, exclude paragraphs within blockquote tags
$tag = 'p[not(descendant::img) and not(parent::blockquote)]';
* Handle: 1) "img" tags 2) "image" block 3) "gallery" block 4) "gallery shortcode" 5) "wp_caption" shortcode
* Handle the gallery created by the block or the shortcode as one image.
* Prevent injection of ads next to images in tables.
// Default shortcodes, including non-HTML5 versions.
$shortcodes = "@class and (
contains(concat(' ', normalize-space(@class), ' '), ' gallery-size') or
contains(concat(' ', normalize-space(@class), ' '), ' wp-caption ') )";
$tag = "*[self::img or self::figure or self::div[$shortcodes]]
[not(ancestor::table or ancestor::figure or ancestor::div[$shortcodes])]";
// any headline. By default h2, h3, and h4
$headlines = apply_filters( 'advanced-ads-headlines-for-ad-injection', [ 'h2', 'h3', 'h4' ] );
foreach ( $headlines as &$headline ) {
$headline = 'self::' . $headline;
$tag = '*[' . implode( ' or ', $headlines ) . ']'; // /html/body/*[self::h2 or self::h3 or self::h4]
// any HTML element that makes sense in the content
$tag = '*[not(self::' . implode( ' or self::', $exclude ) . ')]';
// get the path for the "custom" tag choice, use p as a fallback to prevent it from showing any ads if users left it empty
$tag = ! empty( $placement_opts['xpath'] ) ? stripslashes( $placement_opts['xpath'] ) : 'p';
$xpath = new DOMXPath( $dom );
if ( $options['itemLimit'] !== -1 ) {
$items = $xpath->query( '/html/body/' . $tag );
if ( $items->length < $options['itemLimit'] ) {
$items = $xpath->query( '/html/body/*/' . $tag );
if ( $items->length < $options['itemLimit'] ) {
$items = $xpath->query( '/html/body/*/*/' . $tag );
// try all levels as last resort.
if ( $items->length < $options['itemLimit'] ) {
$items = $xpath->query( '//' . $tag );
$items = $xpath->query( $tag );
// allow to select other elements.
$items = apply_filters( 'advanced-ads-placement-content-injection-items', $items, $xpath, $tag_option );
// filter empty tags from items.
$whitespaces = json_decode( '"\t\n\r \u00A0"' );
foreach ( $items as $item ) {
if ( $options['allowEmpty'] || ( isset( $item->textContent ) && trim( $item->textContent, $whitespaces ) !== '' ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$ancestors_to_limit = self::get_ancestors_to_limit( $xpath );
$paragraphs = self::filter_by_ancestors_to_limit( $paragraphs, $ancestors_to_limit );
$options['paragraph_count'] = count( $paragraphs );
if ( $options['paragraph_count'] >= $options['paragraph_id'] ) {
$offset = $options['paragraph_select_from_bottom'] ? $options['paragraph_count'] - $options['paragraph_id'] : $options['paragraph_id'] - 1;
$offsets = apply_filters( 'advanced-ads-placement-content-offsets', [ $offset ], $options, $placement_opts, $xpath, $paragraphs, $dom );
foreach ( $offsets as $offset ) {
$node = apply_filters( 'advanced-ads-placement-content-injection-node', $paragraphs[ $offset ], $tag, $options['before'] );
if ( $options['alter_nodes'] ) {
// Prevent injection into image caption and gallery.
for ( $i = 0; $i < 4; $i++ ) {
$parent = $parent->parentNode;
if ( ! $parent instanceof DOMElement ) {
if ( preg_match( '/\b(wp-caption|gallery-size)\b/', $parent->getAttribute( 'class' ) ) ) {
// make sure that the ad is injected outside the link
if ( 'img' === $tag_option && 'a' === $node->parentNode->tagName ) {
if ( $options['before'] ) {
// go one level deeper if inserted after to not insert the ad into the link; probably after the paragraph
$node->parentNode->parentNode;
$ad_content = (string) Advanced_Ads_Select::get_instance()->get_ad_by_method( $placement_id, 'placement', $placement_opts );
if ( trim( $ad_content, $whitespaces ) === '' ) {
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$ad_content = self::filter_ad_content( $ad_content, $node->tagName, $options );
$ad_dom = new DOMDocument( '1.0', $wp_charset );
$libxml_use_internal_errors = libxml_use_internal_errors( true );
$ad_dom->loadHtml( '<!DOCTYPE html><html><meta http-equiv="Content-Type" content="text/html; charset=' . $wp_charset . '" /><body>' . $ad_content );
switch ( $options['position'] ) {
foreach ( $ad_dom->getElementsByTagName( 'body' )->item( 0 )->childNodes as $importedNode ) {
$importedNode = $dom->importNode( $importedNode, true );
$ref_node->appendChild( $importedNode );
foreach ( $ad_dom->getElementsByTagName( 'body' )->item( 0 )->childNodes as $importedNode ) {
$importedNode = $dom->importNode( $importedNode, true );
$ref_node->insertBefore( $importedNode, $ref_node->firstChild );
foreach ( $ad_dom->getElementsByTagName( 'body' )->item( 0 )->childNodes as $importedNode ) {
$importedNode = $dom->importNode( $importedNode, true );
$ref_node->parentNode->insertBefore( $importedNode, $ref_node );
// append before next node or as last child to body.
$ref_node = $node->nextSibling;
if ( isset( $ref_node ) ) {
foreach ( $ad_dom->getElementsByTagName( 'body' )->item( 0 )->childNodes as $importedNode ) {
$importedNode = $dom->importNode( $importedNode, true );
$ref_node->parentNode->insertBefore( $importedNode, $ref_node );
// append to body; -TODO using here that we only select direct children of the body tag.
foreach ( $ad_dom->getElementsByTagName( 'body' )->item( 0 )->childNodes as $importedNode ) {
$importedNode = $dom->importNode( $importedNode, true );
$node->parentNode->appendChild( $importedNode );
libxml_use_internal_errors( $libxml_use_internal_errors );
$content_orig = $content;
// convert to text-representation.
$content = $dom->saveHTML();
$content = self::prepare_output( $content, $content_orig );
* Show a warning to ad admins in the Ad Health bar in the frontend, when
* * the level limitation was not disabled
* * could not inject one ad (as by use of `elseif` here)
* * but there are enough elements on the site, but just in sub-containers
} elseif ( WordPress::user_can( 'advanced_ads_manage_options' )
&& $options['itemLimit'] !== -1
&& empty( $plugin_options['content-injection-level-disabled'] ) ) {
// Check if there are more elements without limitation.
$all_items = $xpath->query( '//' . $tag );
foreach ( $all_items as $item ) {
if ( $options['allowEmpty'] || ( isset( $item->textContent ) && trim( $item->textContent, $whitespaces ) !== '' ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar
$paragraphs = self::filter_by_ancestors_to_limit( $paragraphs, $ancestors_to_limit );
if ( $options['paragraph_id'] <= count( $paragraphs ) ) {
// Add a warning to ad health.
add_filter( 'advanced-ads-ad-health-nodes', [ 'Advanced_Ads_In_Content_Injector', 'add_ad_health_node' ] );
* @param string $content Original content.
* @param string $wp_charset blog charset.
* @return string $content Content to load.
private static function get_content_to_load( $content, $wp_charset ) {
// Prevent removing closing tags in scripts.
$content_to_load = preg_replace( '/<script.*?<\/script>/si', '<!--\0-->', $content );
// check which priority the wpautop filter has; might have been disabled on purpose.
$wpautop_priority = has_filter( 'the_content', 'wpautop' );
if ( $wpautop_priority && Advanced_Ads_Plugin::get_instance()->get_content_injection_priority() < $wpautop_priority ) {
$content_to_load = wpautop( $content_to_load );
* @param string $ad_content Ad content.
* @param string $tag_name tar before/after the content.
* @param array $options Injection options.
* @return string ad content.
private static function filter_ad_content( $ad_content, $tag_name, $options ) {
// Replace `</` with `<\/` in ad content when placed within `document.write()` to prevent code from breaking.
$ad_content = preg_replace( '#(document.write.+)</(.*)#', '$1<\/$2', $ad_content );
$id = count( self::$ads_for_placeholders );
self::$ads_for_placeholders[] = [
'position' => $options['position'],
return '%advads_placeholder_' . $id . '%';
* @param string $content Modified content.
* @param string $content_orig Original content.
* @return string $content Content to output.
private static function prepare_output( $content, $content_orig ) {
$content = self::inject_ads( $content, $content_orig, self::$ads_for_placeholders );
self::$ads_for_placeholders = [];
* Search for ad placeholders in the `$content` to determine positions at which to inject ads.
* Given the positions, inject ads into `$content_orig.
* @param string $content Post content with injected ad placeholders.
* @param string $content_orig Unmodified post content.
* @param array $ads_for_placeholders Array of ads.
* Each ad contains placeholder id, before or after which tag to inject the ad, the ad content.
* @return string $content
private static function inject_ads( $content, $content_orig, $ads_for_placeholders ) {
// It is not possible to append/prepend in self closing tags.
foreach ( $ads_for_placeholders as &$ad_content ) {
if ( ( 'prepend' === $ad_content['position'] || 'append' === $ad_content['position'] )
&& in_array( $ad_content['tag'], $self_closing_tags, true ) ) {
$ad_content['position'] = 'after';
usort( $ads_for_placeholders, [ 'Advanced_Ads_In_Content_Injector', 'sort_ads_for_placehoders' ] );
// Add tags before/after which ad placehoders were injected.
foreach ( $ads_for_placeholders as $ad_content ) {
$tag = $ad_content['tag'];
switch ( $ad_content['position'] ) {
$alts[] = "<{$tag}[^>]*>";
if ( in_array( $tag, $self_closing_tags, true ) ) {
$alts[] = "<{$tag}[^>]*>";
$alts = array_unique( $alts );
$tag_regexp = implode( '|', $alts );
$alts[] = '%advads_placeholder_(?:\d+)%';
$tag_and_placeholder_regexp = implode( '|', $alts );
preg_match_all( "#{$tag_and_placeholder_regexp}#i", $content, $tag_matches );