feat(rss-feed): Add Feed enhancements for Republications. by Takshil-Kunadia · Pull Request #3801 · Automattic/newspack-plugin

Takshil-Kunadia · 2025-03-06T09:27:47Z

All Submissions:

Have you followed the Newspack Contributing guideline?
Does your code follow the WordPress' coding standards and VIP Go coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Addresses https://app.asana.com/0/0/1209344511155915/f .

Add relevant options to the RSS Feed settings, if the Republication tracker plugin is activated:
- A checkbox to add a republication tracker snippet to posts.
- A checkbox to filter the feed to only include republishable posts.
- A select field to choose between RSS and Atom feed formats.
When the user selects the Atom feed format, the "Wrap the content of <title> elements in CDATA tags" option is disabled and forced to false (since WordPress Atom feeds encoded title by default).
Adjusts the feed URL generation and query modifications to reflect the selected feed format.
Outputs the <republication_tracker> tag in the feed when the tracker option is enabled.
Modifies the meta query so that only posts not marked to hide the republishing button are included when filtering is active.

How to test the changes in this Pull Request:

Install & Configure Republication Tracker Tool.
Create Feeds from Admin > RSS Feeds.
Check for new options.
- Checkbox for adding republication tracker pixel.
- Checkbox for only including republishable posts.
- Select for RSS or Atom feeds.
Try the above settings and check the feed link generated.
If republication tracker pixel checkbox is clicked a <republication_tracker> tag is included adding the tracking pixel.
If only Include Republishable posts checkbox is added, only posts which have "Hide Republishing Button" metabox checkbox unchecked will be included.
RSS & Atom feeds will be displayed based on the selected feed type.

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you successfully ran tests with your changes locally?

Takshil-Kunadia · 2025-03-06T09:44:23Z

 		</table>

 		<script>
+			const handleCDATA = function() {


Need to do this as WordPress atom feed wraps title in CDATA by default.

leogermani · 2025-03-07T14:37:51Z

oh, I made some changes before seeing @adekbadek 's comments. Please take his advice, they're better. I didn't know that both feed formats were available for all custom feeds.

One thing I did though is to only apply the query filter for republishable posts if the plugin is active

leogermani · 2025-03-07T14:50:42Z

Also, you are including the tracking snippet as a new tag in the feed. Not sure if that's what we want or if we just want to append that to the post content itself. @claudiulodro ?

Takshil-Kunadia · 2025-03-10T11:52:04Z

@adekbadek @leogermani Thanks for the thoughtful feedback!
I have made the changes required. Please review 🙇

adekbadek · 2025-03-10T16:14:41Z

+		// If the Republication Tracker Tool is enabled and the option is checked, output the tracker snippet.
+		if ( ! empty( $settings['republication_tracker'] ) && method_exists( 'Republication_Tracker_Tool', 'create_tracking_pixel_markup' ) ) {
+			?>
+			<republication_tracker><?php echo \Republication_Tracker_Tool::create_tracking_pixel_markup( $post->ID ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></republication_tracker>


Echoing @leogermani 's question – why is the pixel wrapped in a custom tag?

(answered here)

@adekbadek I'm not entirely sure I captured the change as intended, so I've updated the code to append the tracking snippet at the end of the content in feat(rss): address tracking snippet feedback along with taking care of attribution setting as shared by @claudiulodro . Please do let me know if this is what was required or if further adjustments are needed.

cc: @claudiulodro

claudiulodro · 2025-03-10T17:22:53Z

For the tracking snippet, let's include that as a <script> tag at the end of the post content please, like how the pixel is included in the "regular" content

github-actions · 2025-03-12T08:32:43Z

Hey @Takshil-Kunadia, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label.

If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label.

Thank you! ❤️

# [6.2.0-alpha.1](v6.1.1...v6.2.0-alpha.1) (2025-03-20) ### Bug Fixes * **ga:** check if post is not null before reading properties ([#3817](#3817)) ([9dfa47a](9dfa47a)) * **modal-checkout:** endpoint to refresh newsletter lists via REST ([#3841](#3841)) ([79ea458](79ea458)) * **reader-revenue:** fatal when using woocommerce-paypal-payments@3.0.0 ([#3848](#3848)) ([1d73e17](1d73e17)) * update paths to share button, social CSS in Perfmatters ([#3810](#3810)) ([eb2ca7e](eb2ca7e)) ### Features * add Lite sites feature ([#3807](#3807)) ([cbd3e61](cbd3e61)) * **corrections-location:** integrate Correction location logic ([#3829](#3829)) ([6a7cd45](6a7cd45)) * enable email change for newspack users ([#3824](#3824)) ([1bfb458](1bfb458)) * **media:** enable setting a default image for 404 images ([#3811](#3811)) ([465928e](465928e)) * **memberships:** status reevaluation ([#3845](#3845)) ([ba4bea9](ba4bea9)) * **my-account:** disable WC password nag ([a22e756](a22e756)) * **rss-feed:** add feed enhancements for republication tracker; Atom feed URL ([#3801](#3801)) ([719983f](719983f)) * **woo-member-commenting:** optional module for member commenting ([#3783](#3783)) ([262f8bf](262f8bf)) ### Reverts * Revert "refactor(corrections): remove corrections feature flag (#3797)" (#3825) ([f5f6a5c](f5f6a5c)), closes [#3797](#3797) [#3825](#3825)

matticbot · 2025-03-20T19:22:22Z

🎉 This PR is included in version 6.2.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

* feat(my-account): disable WC password nag * feat(woo-member-commenting): optional module for member commenting (#3783) * feat(woo-member-commenting): optional module for member commenting * feat(woo-comments): use a constant array for settings * Remove punctuation Co-authored-by: Derrick Koo <dkoo@users.noreply.github.com> --------- Co-authored-by: Derrick Koo <dkoo@users.noreply.github.com> * fix: update paths to share button, social CSS in Perfmatters (#3810) * feat(media): enable setting a default image for 404 images (#3811) * fix(ga): check if post is not null before reading properties (#3817) * feat(rss-feed): add feed enhancements for republication tracker; Atom feed URL (#3801) * feat: add Lite sites feature (#3807) * feat: add Lite sites feature * feat: add lite site settings page * feat(lite-site): update style * fix: a few tweaks * fix: i18n * fix: option name * feat: add hook to allow styles customizations * fix: a few tweaks to the UI * feat: i18n for strings --------- Co-authored-by: Thomas Guillot <thomas@automattic.com> * Fix: Guest Contributors Role Init for CLI and PHPUnit (#3828) * fix: guest contributors role init for CLI (non-admin) * fix: guest contributors role init: move line * fix: guest contributors role init: phpcs cleanup * Revert "refactor(corrections): remove corrections feature flag (#3797)" (#3825) This reverts commit 7776957. * feat: enable email change for newspack users (#3824) * feat: enable email change for newspack users * fix: check ff for non-a12s * test: update JS tests (#3818) * deps: update testing-library * refator: prevent react warnings * test: fix test failing after testing-library update * feat(corrections-location): integrate Correction location logic (#3829) * refactor(corrections): remove customizer settings for corrections location * feat(corrections): add location metadata to corrections and update modal * feat(corrections): separate corrections by location and update markup generation * fix(tests): update correction tests * refactor(corrections): simplify location check * feat: update button label * fix: clear empty space * docs: update docs * refactor: remove unused corrections active meta key * feat: remove shortcode * refactor: remove obsolete corrections shortcode tests --------- Co-authored-by: Leo Germani <leogermani@automattic.com> * fix(modal-checkout): endpoint to refresh newsletter lists via REST (#3841) This PR fixes an issue where the newsletters modal was incorrectly showing all premium newsletters. We fix this by refreshing the newsletters lists post checkout. * test: fix corrections test * fix(reader-revenue): fatal when using woocommerce-paypal-payments@3.0.0 (#3848) * feat(memberships): status reevaluation (#3845) * feat(memberships): status reevaluation * chore: fix linting * chore(release): 6.2.0-alpha.1 [skip ci] # [6.2.0-alpha.1](v6.1.1...v6.2.0-alpha.1) (2025-03-20) ### Bug Fixes * **ga:** check if post is not null before reading properties ([#3817](#3817)) ([9dfa47a](9dfa47a)) * **modal-checkout:** endpoint to refresh newsletter lists via REST ([#3841](#3841)) ([79ea458](79ea458)) * **reader-revenue:** fatal when using woocommerce-paypal-payments@3.0.0 ([#3848](#3848)) ([1d73e17](1d73e17)) * update paths to share button, social CSS in Perfmatters ([#3810](#3810)) ([eb2ca7e](eb2ca7e)) ### Features * add Lite sites feature ([#3807](#3807)) ([cbd3e61](cbd3e61)) * **corrections-location:** integrate Correction location logic ([#3829](#3829)) ([6a7cd45](6a7cd45)) * enable email change for newspack users ([#3824](#3824)) ([1bfb458](1bfb458)) * **media:** enable setting a default image for 404 images ([#3811](#3811)) ([465928e](465928e)) * **memberships:** status reevaluation ([#3845](#3845)) ([ba4bea9](ba4bea9)) * **my-account:** disable WC password nag ([a22e756](a22e756)) * **rss-feed:** add feed enhancements for republication tracker; Atom feed URL ([#3801](#3801)) ([719983f](719983f)) * **woo-member-commenting:** optional module for member commenting ([#3783](#3783)) ([262f8bf](262f8bf)) ### Reverts * Revert "refactor(corrections): remove corrections feature flag (#3797)" (#3825) ([f5f6a5c](f5f6a5c)), closes [#3797](#3797) [#3825](#3825) * feat: add custom check for media visibility (#3823) * feat(corrections-modal): Improve Corrections Modal UX (#3835) * feat(corrections-modal): enhance corrections modal UX with notices and card layout * feat(corrections-modal): replace success notice with snackbar * refactor(corrections-modal): replaced contained notice with global notice * feat(corrections-modal): reorganise panels * feat(corrections-modal): enforce correction saving --------- Co-authored-by: Thomas Guillot <thomas@automattic.com> * feat(corrections-modal): fix modal action buttons & state handling (#3852) * feat(correction): Add Priority setting & refactor Block (#3844) * feat(corrections): update correction box to have location settings * feat(corrections-blocks): add variations for top and bottom correction box * feat(correction-box): change default location to 'all' in block attributes * feat(correction-box): upgrade variations and update icons * refactor(corrections): change location meta to priority and update related logic * refactor(correction-box): rename location setting to priority & update its logic & remove variations * refactor(corrections-modal): rename location to priority and update related logic * docs: update docs --------- Co-authored-by: Leo Germani <leogermani@automattic.com> * chore(release): 6.2.0-alpha.2 [skip ci] # [6.2.0-alpha.2](v6.2.0-alpha.1...v6.2.0-alpha.2) (2025-03-25) ### Bug Fixes * **reader-revenue:** fatal when using woocommerce-paypal-payments@3.0.0 ([#3848](#3848)) ([a3f6d6a](a3f6d6a)) * **woocommerce-email:** fix the subscription cancellation email ([fc1cc8c](fc1cc8c)) * fix: add check if product before gating content (#3850) * chore(release): 6.2.0-alpha.3 [skip ci] # [6.2.0-alpha.3](v6.2.0-alpha.2...v6.2.0-alpha.3) (2025-03-26) ### Bug Fixes * **esp-sync:** account for wp errors in email change sync ([#3860](#3860)) ([d5d576d](d5d576d)) * feat: update custom bylines data structure (#3863) * feat: information architecture (#3857) Co-authored-by: Jared Rethman <jaredrethman@gmail.com> Co-authored-by: Ron Chambers <116242607+ronchambers@users.noreply.github.com> Co-authored-by: Derrick Koo <dkoo@users.noreply.github.com> Co-authored-by: Rasmy Nguyen <raz@automattic.com> Co-authored-by: Thomas Guillot <thomasguillot@users.noreply.github.com> Co-authored-by: Laurel <laurel.fulford@automattic.com> * feat: add canonical url to lite site single posts (#3865) * chore(release): 6.2.0-alpha.4 [skip ci] # [6.2.0-alpha.4](v6.2.0-alpha.3...v6.2.0-alpha.4) (2025-03-26) ### Bug Fixes * add check if product before gating content ([#3850](#3850)) ([b9e385d](b9e385d)) ### Features * add canonical url to lite site single posts ([#3865](#3865)) ([471ad81](471ad81)) * add custom check for media visibility ([#3823](#3823)) ([c1d81dc](c1d81dc)) * **correction:** Add Priority setting & refactor Block ([#3844](#3844)) ([9232750](9232750)) * **corrections-modal:** fix modal action buttons & state handling ([#3852](#3852)) ([220d5d6](220d5d6)) * **corrections-modal:** Improve Corrections Modal UX ([#3835](#3835)) ([afc9844](afc9844)) * information architecture ([#3857](#3857)) ([6fb5951](6fb5951)) * update custom bylines data structure ([#3863](#3863)) ([9b66c1f](9b66c1f)) * fix(ia): render all emails on reset (#3867) This fixes an issue where resetting an email template in Newspack > Settings > Emails would only render Woo templates on success. * chore(release): 6.2.0-alpha.5 [skip ci] # [6.2.0-alpha.5](v6.2.0-alpha.4...v6.2.0-alpha.5) (2025-03-27) ### Bug Fixes * **ia:** render all emails on reset ([#3867](#3867)) ([519890f](519890f)) * fix(image-404-handling): handle 404 from other sites * chore(release): 6.2.0-alpha.6 [skip ci] # [6.2.0-alpha.6](v6.2.0-alpha.5...v6.2.0-alpha.6) (2025-03-31) ### Bug Fixes * **image-404-handling:** handle 404 from other sites ([51998b8](51998b8)) * test: fix unit tests based on dates relative to "now" (#3875) * fix: handle missing Mailchimp API key in auth status (#3873) * fix: remove Mailchimp for WooCommerce from wizard (#3876) * chore(release): 6.2.0-alpha.7 [skip ci] # [6.2.0-alpha.7](v6.2.0-alpha.6...v6.2.0-alpha.7) (2025-03-31) ### Bug Fixes * handle missing Mailchimp API key in auth status ([#3873](#3873)) ([81a6e51](81a6e51)) * remove Mailchimp for WooCommerce from wizard ([#3876](#3876)) ([4353a98](4353a98)) * fix(notices): fix PHP notice (#3872) --------- Co-authored-by: matticbot <sysops+ghmatticbot@automattic.com> Co-authored-by: Adam Cassis <adam.cassis@automattic.com> Co-authored-by: Camilla Krag Jensen <naxoc@users.noreply.github.com> Co-authored-by: Laurel <laurel.fulford@automattic.com> Co-authored-by: Adam Cassis <adam@adamcassis.com> Co-authored-by: Eddie Carrasco <eddies.code.shop@gmail.com> Co-authored-by: Takshil Kunadia <71006004+Takshil-Kunadia@users.noreply.github.com> Co-authored-by: leogermani <leogermani@automattic.com> Co-authored-by: Thomas Guillot <thomas@automattic.com> Co-authored-by: Ron Chambers <116242607+ronchambers@users.noreply.github.com> Co-authored-by: Rasmy Nguyen <raz@automattic.com> Co-authored-by: matticbot <semantic-release-bot@martynus.net> Co-authored-by: Miguel Peixe <miguel.peixe@automattic.com> Co-authored-by: Jared Rethman <jaredrethman@gmail.com> Co-authored-by: Thomas Guillot <thomasguillot@users.noreply.github.com>

# [6.2.0](v6.1.3...v6.2.0) (2025-03-31) ### Bug Fixes * add check if product before gating content ([#3850](#3850)) ([b9e385d](b9e385d)) * **ga:** check if post is not null before reading properties ([#3817](#3817)) ([9dfa47a](9dfa47a)) * handle missing Mailchimp API key in auth status ([#3873](#3873)) ([81a6e51](81a6e51)) * **ia:** render all emails on reset ([#3867](#3867)) ([519890f](519890f)) * **image-404-handling:** handle 404 from other sites ([51998b8](51998b8)) * **modal-checkout:** endpoint to refresh newsletter lists via REST ([#3841](#3841)) ([79ea458](79ea458)) * **notices:** fix PHP notice ([#3872](#3872)) ([9cda1ca](9cda1ca)) * **reader-revenue:** fatal when using woocommerce-paypal-payments@3.0.0 ([#3848](#3848)) ([1d73e17](1d73e17)) * remove Mailchimp for WooCommerce from wizard ([#3876](#3876)) ([4353a98](4353a98)) * update paths to share button, social CSS in Perfmatters ([#3810](#3810)) ([eb2ca7e](eb2ca7e)) ### Features * add canonical url to lite site single posts ([#3865](#3865)) ([471ad81](471ad81)) * add custom check for media visibility ([#3823](#3823)) ([c1d81dc](c1d81dc)) * add Lite sites feature ([#3807](#3807)) ([cbd3e61](cbd3e61)) * **correction:** Add Priority setting & refactor Block ([#3844](#3844)) ([9232750](9232750)) * **corrections-location:** integrate Correction location logic ([#3829](#3829)) ([6a7cd45](6a7cd45)) * **corrections-modal:** fix modal action buttons & state handling ([#3852](#3852)) ([220d5d6](220d5d6)) * **corrections-modal:** Improve Corrections Modal UX ([#3835](#3835)) ([afc9844](afc9844)) * enable email change for newspack users ([#3824](#3824)) ([1bfb458](1bfb458)) * information architecture ([#3857](#3857)) ([6fb5951](6fb5951)) * **media:** enable setting a default image for 404 images ([#3811](#3811)) ([465928e](465928e)) * **memberships:** status reevaluation ([#3845](#3845)) ([ba4bea9](ba4bea9)) * **my-account:** disable WC password nag ([a22e756](a22e756)) * **rss-feed:** add feed enhancements for republication tracker; Atom feed URL ([#3801](#3801)) ([719983f](719983f)) * update custom bylines data structure ([#3863](#3863)) ([9b66c1f](9b66c1f)) * **woo-member-commenting:** optional module for member commenting ([#3783](#3783)) ([262f8bf](262f8bf)) ### Reverts * Revert "refactor(corrections): remove corrections feature flag (#3797)" (#3825) ([f5f6a5c](f5f6a5c)), closes [#3797](#3797) [#3825](#3825)

Takshil-Kunadia added 2 commits March 6, 2025 14:06

feat(rss): add republication tracker enhancements

dc99069

fix(rss): handle title for Atom feed

268e93d

Takshil-Kunadia marked this pull request as ready for review March 6, 2025 09:32

Takshil-Kunadia requested a review from a team as a code owner March 6, 2025 09:32

Takshil-Kunadia requested a review from leogermani March 6, 2025 09:34

Takshil-Kunadia commented Mar 6, 2025

View reviewed changes

adekbadek requested changes Mar 7, 2025

View reviewed changes

Comment thread includes/optional-modules/class-rss.php Outdated

Comment thread includes/optional-modules/class-rss.php Outdated

leogermani added 2 commits March 7, 2025 11:34

feat: only apply RTT query filter if RTT is active

76b156f

feat: atom option not dependent on RTT

c1ff3dc

fix(rss): address feedback and refactor code

65495e0

Takshil-Kunadia requested a review from adekbadek March 10, 2025 11:52

feat(rss): refactor republication tracker checks

34020e4

adekbadek requested changes Mar 10, 2025

View reviewed changes

Takshil-Kunadia added 2 commits March 11, 2025 12:55

fix(rss): cosmetic changes

6240e8f

feat(rss): address tracking snippet feedback

cc0e2a4

Takshil-Kunadia requested a review from adekbadek March 12, 2025 07:10

adekbadek approved these changes Mar 12, 2025

View reviewed changes

github-actions Bot added the [Status] Approved The pull request has been reviewed and is ready to merge label Mar 12, 2025

adekbadek merged commit 719983f into trunk Mar 12, 2025

adekbadek deleted the feature/rss-republication-enhancements branch March 12, 2025 08:32

github-actions Bot added the needs-changelog label Mar 12, 2025

adekbadek removed the needs-changelog label Mar 12, 2025

matticbot added the released on @alpha label Mar 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rss-feed): Add Feed enhancements for Republications.#3801

feat(rss-feed): Add Feed enhancements for Republications.#3801
adekbadek merged 8 commits into
trunkfrom
feature/rss-republication-enhancements

Takshil-Kunadia commented Mar 6, 2025 •

edited

Loading

Uh oh!

Takshil-Kunadia Mar 6, 2025

Uh oh!

Uh oh!

Uh oh!

leogermani commented Mar 7, 2025

Uh oh!

leogermani commented Mar 7, 2025

Uh oh!

Takshil-Kunadia commented Mar 10, 2025

Uh oh!

Uh oh!

Uh oh!

adekbadek Mar 10, 2025

Uh oh!

adekbadek Mar 11, 2025

Uh oh!

Takshil-Kunadia Mar 11, 2025

Uh oh!

claudiulodro commented Mar 10, 2025

Uh oh!

github-actions Bot commented Mar 12, 2025

Uh oh!

matticbot commented Mar 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Takshil-Kunadia commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All Submissions:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Other information:

Uh oh!

Takshil-Kunadia Mar 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

leogermani commented Mar 7, 2025

Uh oh!

leogermani commented Mar 7, 2025

Uh oh!

Takshil-Kunadia commented Mar 10, 2025

Uh oh!

Uh oh!

Uh oh!

adekbadek Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

adekbadek Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

Takshil-Kunadia Mar 11, 2025

Choose a reason for hiding this comment

Uh oh!

claudiulodro commented Mar 10, 2025

Uh oh!

github-actions Bot commented Mar 12, 2025

Uh oh!

matticbot commented Mar 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Takshil-Kunadia commented Mar 6, 2025 •

edited

Loading