Fix get_post_oembed_url_function for draft and schedule posts

[Debarghya-Banerjee]

Trac Ticket: Core-42733

Problem

The get_post_embed_url() function was failing to generate the correct embed URLs for draft and scheduled posts when pretty permalinks were enabled. The issue specifically occurred for these draft and scheduled posts, where the embed URLs were being generated incorrectly:

• When pretty permalinks were disabled, the function correctly generated embed URLs for draft and scheduled posts with the ?embed=true query parameter (e.g., http://example.com/?p=8&embed=true), which is recognized as a valid embed URL by WordPress.

• When pretty permalinks were enabled, the function incorrectly generated URLs like http://example.com/?p=8/embed/ for draft and scheduled posts. These URLs were not recognized as embed URLs, causing the is_embed() check to fail (returning false instead of the expected true).

• This discrepancy occurred because get_permalink() does not return pretty permalinks for draft or scheduled posts. As a result, the embed URL logic was inconsistent for draft and scheduled posts, leading to test failures.

Solution

• To address this issue, the logic in get_post_embed_url() has been updated to consistently generate correct embed URLs for all posts (published, draft, or scheduled), regardless of whether pretty permalinks are enabled.

Key changes include

For Published Posts

• When pretty permalinks are enabled, the embed URL now correctly ends with /embed/ (e.g., http://example.com/my-post/embed/), as expected.

• If pretty permalinks are disabled, the function falls back to using the ?embed=true query parameter format (e.g., http://example.com/?p=8&embed=true).

For Draft and Scheduled Posts

• The function now consistently generates embed URLs with the ?embed=true query parameter for draft and scheduled posts, regardless of whether pretty permalinks are enabled. This ensures that draft and scheduled posts are always recognized as embed URLs.

Fallback Logic:

• The function now gracefully handles conflicts between the post's permalink structure and the /embed/ path to avoid generating invalid URLs. In cases where the permalink structure conflicts, the function defaults to the query string format (?embed=true).

Benefits

• Consistent URL Format: Ensures that embed URLs are correctly generated for all post statuses (published, draft, and scheduled), regardless of the permalink structure.

• Correct Handling of Pretty Permalinks: Fixes the issue where pretty permalinks caused the function to generate invalid embed URLs for draft and scheduled posts. Now, get_post_embed_url() always returns a valid embed URL with the correct format.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props debarghyabanerjee, apermo.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• The Plugin and Theme Directories cannot be accessed within Playground.
• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[apermo]

Looking good now :)