Add filter for the output from `get_sample_permalink`

[simonwheatley]

When getting the sample permalink the post_name is not always set in the Post object at this point. The get_sample_permalink gets around this by hacking the post_name into the Post object for the duration of the function, however it is not possible to get this "hacked in" information from the post_type_link filter. I suggest that a filter should be added to the $permalink array (which contains the link and the post name string) and various additional parameters, including the hacked Post object.

The alternative would be to try to detect situations where the data needs to be hacked in, e.g. watching for particular action GET params in an AJAX context, but this seems like a hack too far.

[simonwheatley]

Adds a filter to get_sample_permalink

[simonwheatley]

For context, here's where I would hope to use this in my multi-language plugin: ​https://github.com/simonwheatley/babble/commit/749cd96402a15944a017696282a0e66ee6bb8cfe

[nacin]

Your patch is actually your plugin commit. Could you upload a patch that implements this?

[JustinSainton]

Helping a brother out.

[simonwheatley]

Replying to JustinSainton:

Belated thanks, Justin!

[JustinSainton]

Refreshed against trunk.

[JustinSainton]

Patch still applies cleanly after [25028]

[chriscct7]

Patch needs to be refreshed from src but otherwise it looks fine.

[SergeyBiryukov]

Some cleanup in 22338.4.diff​.

Since we're going to pass the post object to the filter as the last argument, I think we should explicitly pass $post->ID instead of $id, which can be a post ID or post object.

This is not consistent with 'get_sample_permalink_html' filter, which receives $id and not $post->ID, but it's too late to change that.

[wonderboymusic]

In 34309:

Add a 'get_sample_permalink' filter.

Props SergeyBiryukov, wenthemes, JustinSainton.
Fixes #22338.

[SergeyBiryukov]

Replying to SergeyBiryukov:

This is not consistent with 'get_sample_permalink_html' filter, which receives $id and not $post->ID, but it's too late to change that.

Actually, let's do that: #33927.