%s
', wp_kses_post( __( 'Use placeholders: {{post-id}} will be replaced with the post ID, and {{post-url}} will be replaced with the post URL.', 'republication-tracker-tool' ) ) ); - echo sprintf( + printf( '%s
', wp_kses_post( __( 'Use placeholders: {{post-id}} will be replaced with the post ID, and {{post-url}} will be replaced with the post URL.', 'republication-tracker-tool' ) ) ); + printf( '', 'republication_tracker_additional_tracking_code', esc_textarea( $content ) ); - echo sprintf( '%s
', wp_kses_post( __( 'The additional Tracking Code field is where you will be able to input your additional tracking code that will be appended to your copied content.', 'republication-tracker-tool' ) ) ); - echo sprintf( '%s
', wp_kses_post( __( 'Allowed HTML: script, img, iframe, noscript, div, span, p with safe attributes only.', 'republication-tracker-tool' ) ) ); + printf( '%s
', wp_kses_post( __( 'The additional Tracking Code field is where you will be able to input your additional tracking code that will be appended to your copied content.', 'republication-tracker-tool' ) ) ); + printf( '%s
', wp_kses_post( __( 'Allowed HTML: script, img, iframe, noscript, div, span, p with safe attributes only.', 'republication-tracker-tool' ) ) ); } + /** + * Republication Tracker Tool policy callback. + */ public function republication_tracker_tool_policy_callback() { $content = get_option( 'republication_tracker_tool_policy' ); wp_editor( @@ -168,6 +174,9 @@ public function republication_tracker_tool_policy_callback() { printf( '%s
', wp_kses_post( __( 'The Republication Tracker Tool Policy field is where you will be able to input your rules and policies for users to see before they copy and paste your content to republish.As an example of a republication policy hat uses a Creative Commons license, check out the list in this plugin\'s documentation on GitHub.', 'republication-tracker-tool' ) ) ); } + /** + * Republication Tracker Tool analytics ID callback. + */ public function republication_tracker_tool_analytics_id_callback() { $content = get_option( 'republication_tracker_tool_analytics_id' ); printf( @@ -178,6 +187,9 @@ public function republication_tracker_tool_analytics_id_callback() { ); } + /** + * Republication Tracker Tool analytics GA4 ID callback. + */ public function republication_tracker_tool_analytics_ga4_id_callback() { $content = get_option( 'republication_tracker_tool_analytics_ga4_id' ); printf( @@ -188,6 +200,9 @@ public function republication_tracker_tool_analytics_ga4_id_callback() { ); } + /** + * Republication Tracker Tool analytics GA4 secret callback. + */ public function republication_tracker_tool_analytics_ga4_secret_callback() { $content = get_option( 'republication_tracker_tool_analytics_ga4_secret' ); printf( @@ -198,6 +213,9 @@ public function republication_tracker_tool_analytics_ga4_secret_callback() { ); } + /** + * Republication Tracker Tool display attribution callback. + */ public function republication_tracker_tool_display_attribution_callback() { $display_attribution = get_option( 'republication_tracker_tool_display_attribution', 'on' ); ?> @@ -213,6 +231,9 @@ public function republication_tracker_tool_display_attribution_callback() { @@ -231,6 +252,9 @@ public function republication_tracker_tool_media_distribution_callback() { @@ -249,6 +273,9 @@ public function republication_tracker_tool_default_attachment_distribution_callb checked @@ -293,6 +320,9 @@ public function republication_tracker_tool_license_callback() { @@ -308,6 +338,9 @@ public function republication_tracker_tool_default_post_distribution_callback() diff --git a/includes/class-widget.php b/includes/class-widget.php index e833146..90056cb 100644 --- a/includes/class-widget.php +++ b/includes/class-widget.php @@ -13,10 +13,15 @@ */ class Republication_Tracker_Tool_Widget extends WP_Widget { + /** + * Whether the widget has been instantiated. + * + * @var bool + */ public $has_instance = false; /** - * Sets up the widgets name etc + * Sets up the widgets name etc. */ public function __construct() { $widget_ops = array( @@ -27,7 +32,7 @@ public function __construct() { } /** - * Outputs the content of the widget + * Outputs the content of the widget. * * If this is not a single post, don't output the widget. It won't work outside single posts. * @@ -45,11 +50,11 @@ public function widget( $args, $instance ) { $using_license = isset( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ] ); - // our post `republication-tracker-tool-hide-widget` meta is our default filter value + // our post `republication-tracker-tool-hide-widget` meta is our default filter value. $hide_republication_widget_on_post = apply_filters( 'hide_republication_widget', get_post_meta( $post->ID, 'republication-tracker-tool-hide-widget', true ), $post ); - // if `republication-tracker-tool-hide-widget` meta is set to true, don't show the shareable content widget - // OR if the `hide_republication_widget` filter is set to true, don't show the shareable content widget + // if `republication-tracker-tool-hide-widget` meta is set to true, don't show the shareable content widget. + // OR if the `hide_republication_widget` filter is set to true, don't show the shareable content widget. if ( true == $hide_republication_widget_on_post ) { return; } @@ -57,10 +62,10 @@ public function widget( $args, $instance ) { $is_amp = self::is_amp(); if ( ! $is_amp ) { - wp_enqueue_script( 'republication-tracker-tool-clipboard-utils', plugins_url( 'assets/clipboard-utils.js', dirname( __FILE__ ) ), array(), filemtime( plugin_dir_path( __FILE__ ) ), false ); - wp_enqueue_script( 'republication-tracker-tool-js', plugins_url( 'assets/widget.js', dirname( __FILE__ ) ), array( 'jquery', 'republication-tracker-tool-clipboard-utils' ), filemtime( plugin_dir_path( __FILE__ ) ), false ); + wp_enqueue_script( 'republication-tracker-tool-clipboard-utils', plugins_url( 'assets/clipboard-utils.js', __DIR__ ), array(), filemtime( plugin_dir_path( __FILE__ ) ), false ); + wp_enqueue_script( 'republication-tracker-tool-js', plugins_url( 'assets/widget.js', __DIR__ ), array( 'jquery', 'republication-tracker-tool-clipboard-utils' ), filemtime( plugin_dir_path( __FILE__ ) ), false ); } - wp_enqueue_style( 'republication-tracker-tool-css', plugins_url( 'assets/widget.css', dirname( __FILE__ ) ), array(), filemtime( plugin_dir_path(__FILE__) ) ); + wp_enqueue_style( 'republication-tracker-tool-css', plugins_url( 'assets/widget.css', __DIR__ ), array(), filemtime( plugin_dir_path( __FILE__ ) ) ); echo wp_kses_post( $args['before_widget'] ); @@ -71,45 +76,45 @@ public function widget( $args, $instance ) { echo '';
if ( empty( $instance['layout'] ) || 'modal' === $instance['layout'] ) {
- echo sprintf(
+ printf(
'',
esc_html__( 'Republish This Story', 'republication-tracker-tool' )
);
}
- if ( ! empty($instance['layout']) && 'page' === $instance['layout'] ) {
- echo sprintf(
+ if ( ! empty( $instance['layout'] ) && 'page' === $instance['layout'] ) {
+ printf(
'',
esc_html__( 'Republish This Story', 'republication-tracker-tool' ),
- esc_url( '/republish' . $_SERVER['REQUEST_URI'] )
+ esc_url( '/republish' . ( isset( $_SERVER['REQUEST_URI'] ) ? sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) ) : '' ) )
);
}
if ( $using_license ) {
- echo sprintf(
+ printf(
'
';
- echo sprintf(
+ printf(
'',
wp_kses_post( wpautop( esc_html( $instance['text'] ) ) )
);
echo wp_kses_post( $args['after_widget'] );
- // if has_instance is false, we can continue with displaying the modal
+ // if has_instance is false, we can continue with displaying the modal.
if ( isset( $this->has_instance ) && false === $this->has_instance ) {
- // update has_instance so the next time the widget is created on the same page, it does not create a second modal
+ // update has_instance so the next time the widget is created on the same page, it does not create a second modal.
$this->has_instance = true;
- // define our path to grab file content from
+ // define our path to grab file content from.
$modal_content_path = plugin_dir_path( __FILE__ ) . 'shareable-content.php';
if ( $is_amp ) {
@@ -129,30 +134,30 @@ public function widget( $args, $instance ) {
}
/**
- * Outputs the options form on admin
+ * Outputs the options form on admin.
*
* @param array $instance The widget options.
*/
public function form( $instance ) {
- echo sprintf( '%s
', esc_html__( 'This widget will only display on single articles.', 'republication-tracker-tool' ) ); - $title = ! empty( $instance['title'] ) ? $instance['title'] : ''; - $text = ! empty( $instance['text'] ) ? $instance['text'] : esc_html__( 'Republish our articles for free, online or in print, under a Creative Commons license.', 'republication-tracker-tool' ); + printf( '%s
', esc_html__( 'This widget will only display on single articles.', 'republication-tracker-tool' ) ); + $title = ! empty( $instance['title'] ) ? $instance['title'] : ''; + $text = ! empty( $instance['text'] ) ? $instance['text'] : esc_html__( 'Republish our articles for free, online or in print, under a Creative Commons license.', 'republication-tracker-tool' ); $layout = ! empty( $instance['layout'] ) ? $instance['layout'] : 'modal' ?>- +
- +
@@ -177,6 +182,11 @@ public function update( $new_instance, $old_instance ) { return $instance; } + /** + * Checks if the current page is an AMP endpoint. + * + * @return bool + */ public static function is_amp() { return function_exists( 'is_amp_endpoint' ) && is_amp_endpoint(); } diff --git a/includes/compatibility-co-authors-plus.php b/includes/compatibility-co-authors-plus.php index 737e1e1..2a4dde0 100644 --- a/includes/compatibility-co-authors-plus.php +++ b/includes/compatibility-co-authors-plus.php @@ -4,6 +4,7 @@ * * @link https://wpvip.com/plugins/co-authors-plus/ * @link https://github.com/Automattic/Co-Authors-Plus + * @package Republication_Tracker_Tool */ /** @@ -14,7 +15,7 @@ * * @link https://github.com/Automattic/Co-Authors-Plus/blob/3.4.3/php/class-coauthors-template-filters.php#L18-L20 the filter that does not trigger * - * @param String $author_string The string returned by get_the_author + * @param String $author_string The string returned by get_the_author. * @since Co-Authors Plus 3.4.3 * @uses coauthors https://github.com/Automattic/Co-Authors-Plus/blob/3.4.3/template-tags.php#L210-L227 * @return String the plain-text byline diff --git a/includes/licenses.php b/includes/licenses.php index 11ea703..e5a1e1d 100644 --- a/includes/licenses.php +++ b/includes/licenses.php @@ -1,47 +1,59 @@ [ - 'label' => 'CC BY 4.0', + 'cc-by-4.0' => [ + 'label' => 'CC BY 4.0', 'description' => 'Creative Commons Attribution 4.0 International License', - 'url' => 'https://creativecommons.org/licenses/by/4.0/', - 'badge' => 'https://licensebuttons.net/l/by/4.0/88x31.png' + 'url' => 'https://creativecommons.org/licenses/by/4.0/', + 'badge' => 'https://licensebuttons.net/l/by/4.0/88x31.png', ], - 'cc-by-sa-4.0' => [ - 'label' => 'CC BY-SA 4.0', + 'cc-by-sa-4.0' => [ + 'label' => 'CC BY-SA 4.0', 'description' => 'Creative Commons Attribution-ShareAlike 4.0 International License', - 'url' => 'https://creativecommons.org/licenses/by-sa/4.0/', - 'badge' => 'https://licensebuttons.net/l/by-sa/4.0/88x31.png' + 'url' => 'https://creativecommons.org/licenses/by-sa/4.0/', + 'badge' => 'https://licensebuttons.net/l/by-sa/4.0/88x31.png', ], - 'cc-by-nc-4.0' => [ - 'label' => 'CC BY-NC 4.0', + 'cc-by-nc-4.0' => [ + 'label' => 'CC BY-NC 4.0', 'description' => 'Creative Commons Attribution-NonCommercial 4.0 International License', - 'url' => 'https://creativecommons.org/licenses/by-nc/4.0/', - 'badge' => 'https://licensebuttons.net/l/by-nc/4.0/88x31.png' + 'url' => 'https://creativecommons.org/licenses/by-nc/4.0/', + 'badge' => 'https://licensebuttons.net/l/by-nc/4.0/88x31.png', ], - 'cc-by-nc-sa-4.0' => [ - 'label' => 'CC BY-NC-SA 4.0', + 'cc-by-nc-sa-4.0' => [ + 'label' => 'CC BY-NC-SA 4.0', 'description' => 'Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License', - 'url' => 'https://creativecommons.org/licenses/by-nc-sa/4.0/', - 'badge' => 'https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png' + 'url' => 'https://creativecommons.org/licenses/by-nc-sa/4.0/', + 'badge' => 'https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png', ], REPUBLICATION_TRACKER_TOOL_DEFAULT_LICENSE => [ - 'label' => 'CC BY-ND 4.0', + 'label' => 'CC BY-ND 4.0', 'description' => 'Creative Commons Attribution-NoDerivatives 4.0 International License', - 'url' => 'https://creativecommons.org/licenses/by-nd/4.0/', - 'badge' => 'https://licensebuttons.net/l/by-nd/4.0/88x31.png' + 'url' => 'https://creativecommons.org/licenses/by-nd/4.0/', + 'badge' => 'https://licensebuttons.net/l/by-nd/4.0/88x31.png', ], - 'cc-by-nc-nd-4.0' => [ - 'label' => 'CC BY-NC-ND 4.0', + 'cc-by-nc-nd-4.0' => [ + 'label' => 'CC BY-NC-ND 4.0', 'description' => 'Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License', - 'url' => 'https://creativecommons.org/licenses/by-nc-nd/4.0/', - 'badge' => 'https://licensebuttons.net/l/by-nc-nd/4.0/88x31.png' + 'url' => 'https://creativecommons.org/licenses/by-nc-nd/4.0/', + 'badge' => 'https://licensebuttons.net/l/by-nc-nd/4.0/88x31.png', ], - 'cc-zero-1.0' => [ - 'label' => 'CC0 1.0', + 'cc-zero-1.0' => [ + 'label' => 'CC0 1.0', 'description' => 'CC0 1.0 Universal License', - 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/', - 'badge' => 'https://licensebuttons.net/l/zero/1.0/88x31.png' + 'url' => 'https://creativecommons.org/publicdomain/zero/1.0/', + 'badge' => 'https://licensebuttons.net/l/zero/1.0/88x31.png', ], ]; diff --git a/includes/pixel.php b/includes/pixel.php index 163a065..1b294ed 100644 --- a/includes/pixel.php +++ b/includes/pixel.php @@ -1,14 +1,18 @@ post_name ); - $shared_post_permalink = \get_permalink( $shared_post_id ); + $shared_post_permalink = get_permalink( $shared_post_id ); if ( array_key_exists( 'HTTP_REFERER', $_SERVER ) ) { if ( isset( $_SERVER['HTTP_REFERER'] ) ) { - $url = \esc_url_raw( $_SERVER['HTTP_REFERER'] ); + $url = esc_url_raw( $_SERVER['HTTP_REFERER'] ); } - $url_title = \wprtt_get_referring_page_title( $url, $shared_post_id ); + $url_title = wprtt_get_referring_page_title( $url, $shared_post_id ); - $url_host = \wp_parse_url( $url, PHP_URL_HOST ); - $url_path = \wp_parse_url( $url, PHP_URL_PATH ); + $url_host = wp_parse_url( $url, PHP_URL_HOST ); + $url_path = wp_parse_url( $url, PHP_URL_PATH ); } else { @@ -103,7 +106,7 @@ function wprtt_extract_cid_from_cookies() { exit; } - $value = \get_post_meta( $shared_post_id, 'republication_tracker_tool_sharing', true ); + $value = get_post_meta( $shared_post_id, 'republication_tracker_tool_sharing', true ); if ( $value ) { if ( isset( $value[ $url ] ) ) { $value[ $url ]++; @@ -115,16 +118,16 @@ function wprtt_extract_cid_from_cookies() { $url => 1, ); } - $update = \update_post_meta( $shared_post_id, 'republication_tracker_tool_sharing', $value ); + $update = update_post_meta( $shared_post_id, 'republication_tracker_tool_sharing', $value ); // If we have the necessary GA4 info, let's push data to it. // We need both a Measurement ID and an API secret for GA4. // https://developers.google.com/analytics/devguides/collection/protocol/ga4/sending-events?client_type=gtag#required_parameters. - $ga4_id = \get_option( 'republication_tracker_tool_analytics_ga4_id' ); - $ga4_secret = \get_option( 'republication_tracker_tool_analytics_ga4_secret', false ); + $ga4_id = get_option( 'republication_tracker_tool_analytics_ga4_id' ); + $ga4_secret = get_option( 'republication_tracker_tool_analytics_ga4_secret', false ); - if ( $ga4_id && $ga4_secret && isset( $_GET['ga4'] ) && $_GET['ga4'] === $ga4_id ) { - $base_url = \add_query_arg( + if ( $ga4_id && $ga4_secret && isset( $_GET['ga4'] ) && $_GET['ga4'] === $ga4_id ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended + $base_url = add_query_arg( [ 'api_secret' => $ga4_secret, 'measurement_id' => $ga4_id, @@ -149,7 +152,7 @@ function wprtt_extract_cid_from_cookies() { ], ]; - \wp_remote_post( + wp_remote_post( $base_url, [ 'body' => wp_json_encode( $payload ), @@ -160,5 +163,5 @@ function wprtt_extract_cid_from_cookies() { header( 'Content-Type: image/png' ); // A transparent 1x1 px .gif image. -echo base64_decode( 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=' ); +echo base64_decode( 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAXRSTlMAQObYZgAAAApJREFUCNdjYAAAAAIAAeIhvDMAAAAASUVORK5CYII=' ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped exit; diff --git a/includes/shareable-content.php b/includes/shareable-content.php index 83b0c75..970307c 100644 --- a/includes/shareable-content.php +++ b/includes/shareable-content.php @@ -6,17 +6,19 @@ * * Expected URLs is something like /wp-content/plugins/republication-tracker-tool/includes/shareable-content.php?post=22078&_=1512494948576 or something * We aren't passing a NONCE; this isn't a form. + * + * @package Republication_Tracker_Tool */ /** - * The article WP_Post object + * The article WP_Post object. * * @var WP_Post $post the post object */ global $post; /** - * The content of the aforementioned post + * The content of the aforementioned post. * * @var HTML $content */ @@ -45,12 +47,12 @@ */ wp_kses_post( apply_filters( 'republication_tracker_tool_byline', get_the_author() ) ), wp_kses_post( get_bloginfo( 'name' ) ), - wp_kses_post( date( 'F j, Y', strtotime( $post->post_date ) ) ) + wp_kses_post( gmdate( 'F j, Y', strtotime( $post->post_date ) ) ) ); // strip empty tags after automatically applying p tags. $article_info = str_replace( '', '', wpautop( $article_info ) ); -// Check if plain text feature is enabled +// Check if plain text feature is enabled. $plain_text_enabled = Republication_Tracker_Tool_Settings::is_plain_text_enabled(); $plain_text_content = ''; if ( $plain_text_enabled ) { @@ -80,36 +82,36 @@ echo '
';
echo '';
+ echo '' . esc_html__( 'Close window', 'republication-tracker-tool' ) . '';
printf( '
%s
', esc_html__( 'Republish this article', 'republication-tracker-tool' ) ); - // Explain Creative Commons + // Explain Creative Commons. echo '';
echo '
'; // .cc-policy
- // what we display to the embedder
+ // What we display to the embedder.
echo '';
- if ( $using_license ) {
- printf( '
', REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'], REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'], REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['badge'] );
- echo wp_kses_post(
- wpautop(
- sprintf(
- // translators: %1$s is the URL to the particular Creative Commons license.
- __( 'This work is licensed under a %2$s.', 'republication-tracker-tool' ),
- REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
- REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'],
- )
- )
- );
- }
+if ( $using_license ) {
+ printf( '', esc_url( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'] ), esc_html( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'] ), esc_url( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['badge'] ) );
+ echo wp_kses_post(
+ wpautop(
+ sprintf(
+ // translators: %1$s is the URL to the particular Creative Commons license.
+ __( 'This work is licensed under a %2$s.', 'republication-tracker-tool' ),
+ REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
+ REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description']
+ )
+ )
+ );
+}
echo '
'; // .cc-license
- echo "" . wp_kses_post( $license_statement ) . "
"; + echo '' . wp_kses_post( $license_statement ) . '
'; echo '';
echo wp_kses_post( $article_info );
echo '
'; // .article-info
- // the text area that is copyable
- ?>
+ // The text area that is copyable.
+?>
@@ -130,7 +132,7 @@ class="republish-content__textarea "
- >
+ >
@@ -143,7 +145,7 @@ class="republish-content__textarea "
+ value=""
aria-label=""
/>