Add content API url filter

[alecgeatches]

Description

This is a minor filter addition that gives us some useful capabilities when testing. We currently have some test sites that mirror live Parse.ly data from our other sites. In these circumstances, it can be useful to convert some not real local URLs to remote URLs that match our Parse.ly setup, like this:

add_filter( 'wp_parsely_stats_posts_urls', function ( $urls ) {
    return array_map( function ( $url ) {
        return str_replace( 'https://my-local-site.go-vip.net/', 'https://the-real-site.com/', $url );
    }, $urls );
});

This filter adds a foothold so we can easily make those testing changes without editing plugin code.

Motivation and context

This fixes a testing and deployment task we currently need to do when pushing changes to our test sites.

How has this been tested?

Integration tests will cover that this does not cause any issues.

Summary by CodeRabbit

• New Features
  • Added support for external plugins and themes to customize the list of post URLs used in stats-related API requests.

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

A new filter hook, wp_parsely_stats_posts_urls, was introduced in the get_posts method of the Endpoint_Posts class. This filter allows external code to modify the array of post URLs before making a request to the content API. No changes were made to public interfaces or method signatures.

Changes

File(s)	Change Summary
src/rest-api/stats/class-endpoint-posts.php	Added a filter hook wp_parsely_stats_posts_urls in the get_posts method to allow modification of post URLs before API requests.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Endpoint_Posts
    participant External_Filter
    participant Content_API

    Caller->>Endpoint_Posts: get_posts(params)
    Endpoint_Posts->>Endpoint_Posts: Prepare post URLs
    Endpoint_Posts->>External_Filter: Apply 'wp_parsely_stats_posts_urls' filter to URLs
    External_Filter-->>Endpoint_Posts: Return modified URLs
    Endpoint_Posts->>Content_API: Make request with (possibly filtered) URLs
    Content_API-->>Endpoint_Posts: Return results
    Endpoint_Posts-->>Caller: Return results

---

📜 Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 96c715d645efd7968ea766e1133fc7ae77299c33 and bf5f6cb9bc5a269fe317e15077ecf03f0e8b9d34.

📒 Files selected for processing (1)

• src/rest-api/stats/class-endpoint-posts.php (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/rest-api/stats/class-endpoint-posts.php

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: Analyze (javascript)
• GitHub Check: E2E against WordPress latest
• GitHub Check: build
• GitHub Check: build
• GitHub Check: Basic CS and QA checks

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.