Skip to content

Add support for sticky ad #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deepaklalwani97 wants to merge 16 commits into
base: develop
Choose a base branch
from
Open

Add support for sticky ad #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
265b0dc
Add support for sticky ad
deepaklalwani97 Jan 23, 2020
2833e93
Add size for all devices
deepaklalwani97 Jan 24, 2020
61e98f3
Fix phpcs
deepaklalwani97 Jan 24, 2020
88428a5
Fix phpcs ignore comment
deepaklalwani97 Jan 24, 2020
6dc8bd3
Fix phpcs ignore comment
deepaklalwani97 Jan 24, 2020
3d699d5
Update sizes for devices
deepaklalwani97 Jan 24, 2020
11a3f8f
Move sticky ad script to amp-resources template
deepaklalwani97 Jan 24, 2020
abc1f34
Add get_sticky_ad method and code optimizations
deepaklalwani97 Jan 28, 2020
fbcdbaf
Add doc block for get_sticky_ad method
deepaklalwani97 Jan 28, 2020
5692787
Add script only if sticky ads enabled
deepaklalwani97 Jan 30, 2020
0b0d106
Remove extra new line
deepaklalwani97 Jan 30, 2020
a01995b
Merge branch 'develop' of github.com:rtCamp/amp-admanager into featur…
deepaklalwani97 Feb 7, 2020
f581041
Fix amp validation error for amp-ad layout attribute
deepaklalwani97 Apr 3, 2020
656ba7b
Modify get_sticky_ad function to use height and width attributes
deepaklalwani97 Apr 3, 2020
b58e586
Add setting fields for height and width for sticky ad
deepaklalwani97 Jun 15, 2020
bf6a6b1
Use height and width setting fields to apply height and width to ad
deepaklalwani97 Jun 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 77 additions & 2 deletions classes/class-admin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,21 +84,60 @@ public function amp_admanager_menu_init() {
'amp-admanager-menu-page'
);

add_settings_section(
'amp-admanager-sticky-ad-settings',
__( 'Sticky ad Settings', 'amp-admanager' ),
'__return_empty_string',
'amp-admanager-menu-page'
);

add_settings_field(
'dfp-network-id',
__( 'DFP Network ID', 'amp-admanager' ),
esc_html__( 'DFP Network ID', 'amp-admanager' ),
[ $this, 'get_text_field' ],
'amp-admanager-menu-page',
'amp-admanager-general-settings'
);

add_settings_field(
'load-amp-resources',
__( 'Load AMP Resources For Non AMP Site', 'amp-admanager' ),
esc_html__( 'Load AMP Resources For Non AMP Site', 'amp-admanager' ),
[ $this, 'get_checkbox_field' ],
'amp-admanager-menu-page',
'amp-admanager-general-settings'
);

add_settings_field(
'amp_admanager_enable_sticky_ads',
esc_html__( 'Enable Sticky Ads', 'amp-admanager' ),
[ $this, 'get_enable_sticky_ad_checkbox_field' ],
'amp-admanager-menu-page',
'amp-admanager-sticky-ad-settings'
);

add_settings_field(
'amp_admanager_sticky_ad_unit',
esc_html__( 'Sticky adunit name', 'amp-admanager' ),
[ $this, 'get_sticky_adunit_name_field' ],
'amp-admanager-menu-page',
'amp-admanager-sticky-ad-settings'
);

add_settings_field(
'amp_admanager_sticky_ad_height',
esc_html__( 'Sticky Ad height', 'amp-admanager' ),
[ $this, 'get_sticky_adunit_height_field' ],
'amp-admanager-menu-page',
'amp-admanager-sticky-ad-settings'
);

add_settings_field(
'amp_admanager_sticky_ad_width',
esc_html__( 'Sticky Ad width', 'amp-admanager' ),
[ $this, 'get_sticky_adunit_width_field' ],
'amp-admanager-menu-page',
'amp-admanager-sticky-ad-settings'
);
}

/**
Expand All @@ -118,4 +157,40 @@ public function get_checkbox_field() {
public function get_text_field() {
printf( '<input name="amp-admanager-menu-settings[dfp-network-id]" type="text" id="dfp-network-id" value="%s" class="regular-text">', esc_attr( $this->amp_settings['dfp-network-id'] ) );
}

/**
* Prints markup for enable sticky ad checkbox.
*
* @return void
*/
public function get_enable_sticky_ad_checkbox_field() {
printf( '<input name="amp-admanager-menu-settings[amp_admanager_enable_sticky_ads]" type="checkbox" id="amp_admanager_enable_sticky_ads" value="1" %s>', checked( $this->amp_settings['amp_admanager_enable_sticky_ads'], '1', false ) );
}

/**
* Prints markup for adunit name text field.
*
* @return void
*/
public function get_sticky_adunit_name_field() {
printf( '<input name="amp-admanager-menu-settings[amp_admanager_sticky_ad_unit]" type="text" id="amp_admanager_sticky_ad_unit" value="%s" class="regular-text">', esc_attr( $this->amp_settings['amp_admanager_sticky_ad_unit'] ) );
}

/**
* Prints markup for sticky ad width field.
*
* @return void
*/
public function get_sticky_adunit_width_field() {
printf( '<input name="amp-admanager-menu-settings[amp_admanager_sticky_ad_width]" type="text" id="amp_admanager_sticky_ad_width" value="%s" class="regular-text">', esc_attr( $this->amp_settings['amp_admanager_sticky_ad_width'] ) );
}

/**
* Prints markup for sticky ad height field.
*
* @return void
*/
public function get_sticky_adunit_height_field() {
printf( '<input name="amp-admanager-menu-settings[amp_admanager_sticky_ad_height]" type="text" id="amp_admanager_sticky_ad_height" value="%s" class="regular-text">', esc_attr( $this->amp_settings['amp_admanager_sticky_ad_height'] ) );
}
}
64 changes: 57 additions & 7 deletions classes/class-amp-admanager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,12 @@ private static function get_amp_ad( $attr ) {
$network_id = ( ! empty( $attr['network-id'] ) ) ? $attr['network-id'] : self::$amp_settings['dfp-network-id'];
$data_slot = sprintf( '/%s/%s', $network_id, $attr['ad-unit'] );

$media_query = self::get_slot_media_query( $attr['min'], $attr['max'] );
// Add media query only non sticky ads.
if ( empty( $attr['sticky'] ) ) {
$media_query = self::get_slot_media_query( $attr['min'], $attr['max'] );
} else {
$media_query = '';
}

/**
* Encode targeting data for json attribute in amp-ad.
Expand Down Expand Up @@ -183,22 +188,29 @@ private static function get_amp_ad( $attr ) {
*/
$ad_arefresh_rate = ( isset( $attr['ad-refresh'] ) && (int) $attr['ad-refresh'] >= 30 ) ? (int) $attr['ad-refresh'] : false;

/**
* amp-ad markup.
*/
if ( ! empty( $attr['sticky'] ) && true === $attr['sticky'] ) {
$layout = '';
} else {
$layout = sprintf( 'layout=%s', $layout );
}

$ad_html = sprintf(
'<amp-ad width="%s" height="%s" media="%s" type="doubleclick" data-slot="%s" json=\'%s\' data-multi-size="%s" data-multi-size-validation="false" layout="%s" data-loading-strategy="%s" data-enable-refresh=%s></amp-ad>',
'<amp-ad width="%s" height="%s" media="%s" type="doubleclick" data-slot="%s" json=\'%s\' data-multi-size="%s" data-multi-size-validation="false" %s data-loading-strategy="%s" data-enable-refresh=%s></amp-ad>',
esc_attr( $attr['width'] ),
esc_attr( $attr['height'] ),
esc_attr( $media_query ),
esc_attr( $data_slot ),
esc_attr( $targeting_data_json ),
esc_attr( $attr['sizes'] ),
esc_attr( $layout ),
esc_attr( $attr['sizes'] ?? '' ),
$layout,
esc_attr( $data_loading_strategy ),
esc_attr( $ad_arefresh_rate )
);

if ( ! empty( $attr['sticky'] ) && true === $attr['sticky'] ) {
$ad_html = '<amp-sticky-ad layout="nodisplay">' . $ad_html . '</amp-sticky-ad>';
}

return $ad_html;
}

Expand Down Expand Up @@ -265,6 +277,39 @@ public static function get_ads( $attr = [], $echo = false ) {
return $ad_html;
}

/**
* Get amp sticky ad html for all the sizes.
*
* @param array $attr shortcode attributes.
* @param boolean $echo whether to echo or return html code.
*
* @return string
*/
public static function get_sticky_ad( $attr = [], $echo = false ) {

if ( empty( self::$amp_settings['amp_admanager_sticky_ad_unit'] ) || empty( self::$amp_settings['amp_admanager_sticky_ad_width'] ) || empty( self::$amp_settings['amp_admanager_sticky_ad_height'] ) ) {
return;
}

$default_attr = [
'ad-unit' => esc_attr( self::$amp_settings['amp_admanager_sticky_ad_unit'] ),
'width' => esc_attr( self::$amp_settings['amp_admanager_sticky_ad_width'] ),
'height' => esc_attr( self::$amp_settings['amp_admanager_sticky_ad_height'] ),
'layout' => 'fixed',

];

$attr = wp_parse_args( $attr, $default_attr );

$attr['sticky'] = true;

if ( true === $echo ) {
echo self::get_amp_ad( $attr, $echo ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} else {
return self::get_amp_ad( $attr, $echo );
}
}

/**
* Filter sizes for all 3 device type breakpoints.
*
Expand Down Expand Up @@ -410,6 +455,10 @@ public function load_amp_resources() {
<meta name="amp-ad-doubleclick-sra" />
<?php

if ( ! empty( self::$amp_settings['amp_admanager_enable_sticky_ads'] ) ) {
echo '<script async custom-element="amp-sticky-ad" src="https://cdn.ampproject.org/v0/amp-sticky-ad-1.0.js"></script>'; // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedScript
}

// Check if current page is amp page.
if ( function_exists( 'is_amp_endpoint' ) && is_amp_endpoint() ) {
return;
Expand All @@ -430,4 +479,5 @@ public function load_amp_resources() {

}
}

}