Skip to content

Alpha release Aug 29 #272

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

Merged
leogermani merged 1 commit into from
Aug 29, 2025
Merged

Alpha release Aug 29 #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 1 addition & 8 deletions includes/class-content.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,14 +171,7 @@ public static function get_republishable_plain_text_content( $post_object ) {
// Add attribution.
$display_attribution = get_option( 'republication_tracker_tool_display_attribution', 'on' );
if ( 'on' === $display_attribution ) {
$license_key = get_option( 'republication_tracker_tool_license', REPUBLICATION_TRACKER_TOOL_DEFAULT_LICENSE );
$license_description = REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'];
$plain_text_content .= "\n" . sprintf(
// translators: %1$s is the site name, %2$s is the license description.
esc_html__( 'This article first appeared on %1$s and is republished here under a %2$s.', 'republication-tracker-tool' ),
get_bloginfo( 'name' ),
$license_description
) . "\n\n";
$plain_text_content .= Republication_Tracker_Tool::get_attribution( $post_object, true ) . "\n\n";
}

/**
Expand Down
28 changes: 22 additions & 6 deletions includes/class-settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,21 +257,37 @@ public function republication_tracker_tool_license_callback() {
?>
<fieldset>
<p>
<?php foreach ( $licenses as $license_key => $license_values ) : ?>
<?php foreach ( $licenses as $license_key => $license_values ) : ?>
<label>
<input
type="radio"
id="<?php echo esc_attr( 'republication_tracker_tool_license' ) . '_' . $license_key; ?>"
name="<?php echo esc_attr( 'republication_tracker_tool_license' ); ?>"
<?php if ( $license_key === $selected ) : ?>
checked
<?php endif; ?>
value="<?php esc_attr( $license_key ); ?>"
/>
<?php esc_html( $license_values['label'] . ' - ' . $license_values['description'] ); ?>
</label>
<br>
<?php endforeach; ?>

<label>
<input
type="radio"
id="<?php echo esc_attr( 'republication_tracker_tool_license' ) . '_' . $license_key; ?>"
id="republication_tracker_tool_license_none"
name="<?php echo esc_attr( 'republication_tracker_tool_license' ); ?>"
<?php if ( $license_key === $selected ) : ?>
<?php if ( 'none' === $selected ) : ?>
checked
<?php endif; ?>
value="<?php esc_attr_e( $license_key ); ?>"
value="none"
/>
<?php esc_html_e( $license_values['label'] . ' - ' . $license_values['description'] ); ?>
<?php _e( 'No License', 'republication-tracker-tool' ); ?>
</label>
<br>
<?php endforeach; ?>


</p>
</fieldset>
<?php
Expand Down
20 changes: 14 additions & 6 deletions includes/class-widget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ public function widget( $args, $instance ) {

$license_key = get_option( 'republication_tracker_tool_license', REPUBLICATION_TRACKER_TOOL_DEFAULT_LICENSE );

$using_license = isset( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ] );

$license_statement = get_option( 'republication_tracker_tool_policy' );

// 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 );

Expand Down Expand Up @@ -83,12 +87,16 @@ public function widget( $args, $instance ) {
);
}

echo sprintf(
'<p><a class="license" rel="noreferrer license" target="_blank" href="%s"><img alt="%s" style="border-width:0" src="%s" /></a></p>',
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
esc_html__( 'Creative Commons License', 'republication-tracker-tool' ),
esc_url( plugin_dir_url( dirname( __FILE__ ) ) ) . 'assets/img/' . $license_key . '.png'
);
if ( $using_license ) {
echo sprintf(
'<p><a class="license" rel="noreferrer license" target="_blank" href="%s"><img alt="%s" style="border-width:0" src="%s" /></a></p>',
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
esc_html__( 'Creative Commons License', 'republication-tracker-tool' ),
esc_url( plugin_dir_url( dirname( __FILE__ ) ) ) . 'assets/img/' . $license_key . '.png'
);
}

echo "<div class=\"message\">$license_statement</div>";

echo '</div>';

Expand Down
11 changes: 7 additions & 4 deletions includes/shareable-content.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
*/
$license_statement = wp_kses_post( get_option( 'republication_tracker_tool_policy' ) );
$license_key = get_option( 'republication_tracker_tool_license', REPUBLICATION_TRACKER_TOOL_DEFAULT_LICENSE );
$using_license = isset( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ] );

echo '<div id="republication-tracker-tool-modal-content" ' . ( $is_amp ? '' : 'style="display:none;"' ) . '>';
echo '<button ' . ( $is_amp ? 'on="tap:republication-tracker-tool-modal.close"' : '' ) . ' class="republication-tracker-tool-close">';
Expand All @@ -74,7 +75,8 @@

// Explain Creative Commons
echo '<div class="cc-policy">';
echo '<div class="cc-license">';
echo '<div class="cc-license">';
if ( $using_license ) {
printf( '<a rel="noreferrer license" target="_blank" href="%s"><img alt="%s" style="border-width:0" src="%s" /></a>', 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(
Expand All @@ -86,9 +88,10 @@
)
)
);
echo '</div>'; // .cc-license
echo wp_kses_post( $license_statement );
echo '</div>'; // .cc-policy
}
echo '</div>'; // .cc-license
echo "<p>" . wp_kses_post( $license_statement ) . "</p>";
echo '</div>'; // .cc-policy

// what we display to the embedder
echo '<div class="article-info">';
Expand Down
105 changes: 82 additions & 23 deletions republication-tracker-tool.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ public static function create_additional_tracking_code_markup( $post_id ) {
}

/**
* Get attribution text, which will be inserted at the end of the copyable content.
* Get attribution text and tracking code to be added to the content footer
*
* @param $post The shared post.
*/
Expand All @@ -286,35 +286,94 @@ public static function create_content_footer( $post = null ) {
$additional_tracking_code = self::create_additional_tracking_code_markup( $post->ID );
$tracking_html = htmlentities( $pixel ) . htmlentities( $parsely_tracking ) . htmlentities( $additional_tracking_code );

$license_key = get_option( 'republication_tracker_tool_license', 'cc-by-nd-4.0' );
$license_url = REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'];
$license_description = REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'];

$display_attribution = get_option( 'republication_tracker_tool_display_attribution', 'on' );

$attribution = '';

if ( 'on' === $display_attribution && null !== $post ) {
$site_icon_markup = '';
$site_icon_url = get_site_icon_url( 150 );
if ( ! empty( $site_icon_url ) ) {
$site_icon_markup = sprintf(
'<img src="%1$s" style="width:1em;height:1em;margin-left:10px;">',
esc_attr( $site_icon_url ),
);
}
$attribution = self::get_attribution( $post );
}

return $attribution . $tracking_html;
}

/**
* Get attribution text and tracking code to be added to the content footer
*
* @param \WP_Post $post The shared post.
* @param bool $plain_text Whether to return plain text.
*/
public static function get_attribution( \WP_Post $post, $plain_text = false ) {
$license_key = get_option( 'republication_tracker_tool_license', 'cc-by-nd-4.0' );

return wpautop(
sprintf(
// translators: %1$s is a URL, %2$s is the site home URL, %3$s is the site title. %4$s is the license URL, %5$s is the license description.
esc_html__( 'This <a target="_blank" href="%1$s">article</a> first appeared on <a target="_blank" href="%2$s">%3$s</a> and is republished here under a <a target="_blank" href="%4$s">%5$s</a>.', 'republication-tracker-tool' ),
get_permalink( $post ),
home_url(),
$site_icon_markup = '';
$site_icon_url = get_site_icon_url( 150 );
if ( ! empty( $site_icon_url ) ) {
$site_icon_markup = sprintf(
'<img src="%1$s" style="width:1em;height:1em;margin-left:10px;">',
esc_attr( $site_icon_url ),
);
}

if ( isset( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ] ) ) {
$license_url = REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'];
$license_description = REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'];

if ( $plain_text ) {
$attribution = sprintf(
// translators: %1$s is the site title, %2$s is the license description.
esc_html__( 'This article first appeared on %1$s and is republished here under a %2$s.', 'republication-tracker-tool' ),
esc_html( get_bloginfo() ),
$license_url,
$license_description
) . htmlentities( $site_icon_markup ) . $tracking_html
);
);
} else {
$attribution = wpautop(
sprintf(
// translators: %1$s is a URL, %2$s is the site home URL, %3$s is the site title. %4$s is the license URL, %5$s is the license description.
esc_html__( 'This <a target="_blank" href="%1$s">article</a> first appeared on <a target="_blank" href="%2$s">%3$s</a> and is republished here under a <a target="_blank" href="%4$s">%5$s</a>.', 'republication-tracker-tool' ),
get_permalink( $post ),
home_url(),
esc_html( get_bloginfo() ),
$license_url,
$license_description
) . htmlentities( $site_icon_markup )
);
}


} else {

if ( $plain_text ) {
$attribution = sprintf(
// translators: %s is the site title.
esc_html__( 'This article first appeared on %s.', 'republication-tracker-tool' ),
esc_html( get_bloginfo() )
);
} else {

$attribution = wpautop(
sprintf(
// translators: %1$s is a URL, %2$s is the site home URL, %3$s is the site title.
esc_html__( 'This <a target="_blank" href="%1$s">article</a> first appeared on <a target="_blank" href="%2$s">%3$s</a>.', 'republication-tracker-tool' ),
get_permalink( $post ),
home_url(),
esc_html( get_bloginfo() ),
) . htmlentities( $site_icon_markup )
);
}
}
return $tracking_html;

/**
* Filters the attribution HTML for the given post.
*
* @param string $attribution The attribution HTML.
* @param \WP_Post $post The post object.
* @param bool $plain_text Whether the attribution is plain text.
*/
return apply_filters( 'republication_tracker_tool_attribution', $attribution, $post, $plain_text );

}

}

/**
Expand Down
47 changes: 27 additions & 20 deletions templates/republish-template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@

$license_statement = get_option( 'republication_tracker_tool_policy' );
$license_key = get_option( 'republication_tracker_tool_license', REPUBLICATION_TRACKER_TOOL_DEFAULT_LICENSE );
$license_badge = sprintf(
'<a rel="noreferrer license" target="_blank" href="%s"><img alt="%s" style="border-width:0" src="%s" /></a>',
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'],
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['badge']
);

$using_license = isset( REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ] );

if ( $using_license ) {
$license_badge = sprintf(
'<a rel="noreferrer license" target="_blank" href="%s"><img alt="%s" style="border-width:0" src="%s" /></a>',
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'],
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['badge']
);
}

// Article title.
$article_title = get_the_title( $republish_post_id );
Expand Down Expand Up @@ -177,21 +182,23 @@
<?php do_action( 'republication_tracker_tool_before_republish_content', $post_object ); ?>

<div class="cc-policy">
<div class="cc-license">
<?php
echo $license_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 <a rel="noreferrer license" target="_blank" href="%1$s">%2$s</a>.', 'republication-tracker-tool' ),
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'],
<?php if ( $using_license ) : ?>
<div class="cc-license">
<?php
echo $license_badge;
echo wp_kses_post(
wpautop(
sprintf(
// translators: %1$s is the URL to the particular Creative Commons license, %2$s is the license description.
__( 'This work is licensed under a <a rel="noreferrer license" target="_blank" href="%1$s">%2$s</a>.', 'republication-tracker-tool' ),
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['url'],
REPUBLICATION_TRACKER_TOOL_LICENSES[ $license_key ]['description'],
)
)
)
);
?>
</div>
);
?>
</div>
<?php endif; ?>
</div>
<?php if ( ! empty( $license_statement ) ) : ?>
<section class="republish-article__license">
Expand Down