Adding a filter for optional change of public redirect status codes

[infn8]

Adding support for users to change the redirect status code from a 302 to another code of their choice, likely 301.

Tasks

• I have signed a Contributor License Agreement (CLA) with WP Engine.
• If a code change, I have written testing instructions that the whole team & outside contributors can understand.
• I have written and included a comprehensive changeset to properly document the changes I've made.

Description

Added new filter faustwp_public_redirect_status_code, allowing WordPress plugins and themes to choose the HTTP status code to use when generating redirects when the enable public route redirects setting is active.

Related Issue(s):

None

Testing

I added this locally and ensured that the redirects were still 302 status codes. I then added this in my theme's functions.php file to test it

add_filter('faustwp_public_redirect_status_code', function ($status_code) {
	return 301;
}, 10, 1);

Then I tried calling the exact same URL which resulted in a 301 status code with no change to other headers including the x-redirect-by: WP Engine Headless plugin header

Screenshots

none

Documentation Changes

There is nowhere in the repo docs that cover this functionality but there is the following on the live site:

https://faustjs.org/reference/faust-wordpress-plugin-filters

So I am writing here markdown that will get you close, if not all the way to an update for that page which i do not know how to edit:

faustwp_exclude_from_public_redirect: Choose the HTTP status code to use when generating redirects when the enable public route redirects setting is active.

Parameter: $status_code (int): HTTP Status code to use on redirects. Default: 302

Example Usage

// Make the homepage redirect 301 while all others remain unchanged
add_filter('faustwp_public_redirect_status_code', function ($status_code) {
  if(is_front_page()){
    return 301;
  }
  return $status_code;
}, 10, 1);

Dependant PRs

none

[headless-platform-by-wp-engine]

Currently, we do not support the creation of preview deployments based on changes coming from forked repositories.
Learn more about preview environments in our documentation.

[changeset-bot]

🦋 Changeset detected

Latest commit: dc75777

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@faustwp/wordpress-plugin	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[infn8]

🤞 I hope I made that changeset properly. First one!!!

[josephfusco]

Hey @infn8, thank you for taking the time to create this pull request! This looks great to me, and the documentation is clear. I can add it to the main site once a release is cut. 🎉

[headless-platform-by-wp-engine]

Currently, we do not support the creation of preview deployments based on changes coming from forked repositories.
Learn more about preview environments in our documentation.

[infn8]

@josephfusco My pleasure. Glad it works well. I'll keep helping where I can. Thanks for all your work as well.