{"id":584,"date":"2021-02-04T18:45:27","date_gmt":"2021-02-05T01:45:27","guid":{"rendered":"https:\/\/www.bdragon.com\/?p=584"},"modified":"2021-02-04T18:45:32","modified_gmt":"2021-02-05T01:45:32","slug":"fix-wordpress-private-post-url-redirect-loop","status":"publish","type":"post","link":"https:\/\/bdragon.com\/lair\/2021\/02\/fix-wordpress-private-post-url-redirect-loop\/","title":{"rendered":"Fix WordPress Private Post URL Redirect Loop"},"content":{"rendered":"
\n\n\n

Also: An Alternative To Editing functions.php<\/h3>\n\n\n\n

Recently I put up a test post to test the functionality of this site after many updates and upgrades. After I made the post private, I noticed that hitting the URL would not gracefully redirect to an error page or the home page, but instead got stuck in an infinite redirect loop eventually giving an error about “redirected you too many times” or “this page isn’t redirecting properly”. It looks like this in Chrome:<\/p>\n\n\n\n

\"This<\/figure>\n\n\n\n

Or this in Firefox:<\/p>\n\n\n\n

\"The<\/figure>\n\n\n\n

Just in case this particular behavior bothers you, I can explain the steps I took to solve this issue. It turns out you need to remove an action on the “template_redirect” hook called “wp_old_slug_redirect” if you don’t want this endless redirect to occur.<\/p>\n\n\n\n

Note that removing this action could have other consequences… I am assuming that old slugs will not redirect to new slugs after you do this. Many people don’t like this default redirect behavior anyway so it’s up to you to decide if you’re ok with removing it entirely.<\/p>\n\n\n\n

\n\n\n\n

What is an “old slug” and a “new slug” you ask? It is essentially a permalink URL for your WordPress post. An example would be a post you have published at the following URL:<\/p>\n\n\n\n

http:\/\/example.com\/old-slug<\/pre>\n\n\n\n
So if you then decided to change the slug, say to:<\/p>\n\n\n\n
http:\/\/example.com\/new-slug<\/pre>\n\n\n\n
The “wp_old_slug_redirect” action performs a redirect of “old-slug” to “new-slug” whenever anyone visits that old page URL.  Therefore, removing this action via the method I describe below would disable this functionality – so be aware of this.  The end-user should still get the generic WordPress “Not Found” error page though, with the whole theme, links, and a search etc. (see end screen shot below), if this helps you decide.<\/p>\n\n\n\n
\n\n\n\n
Firstly, these instructions apply to WordPress 5.6<\/em> which is the version that I used when implementing these changes.  To remove the action wp_old_slug_redirect<\/em> on the template_redirect<\/em> hook, some said to just edit the “functions.php” file.  I found that there are many reasons you should avoid doing this – for example if you switch your theme, any customizations made in your functions.php file are lost.  Looking for an alternative, I saw that you can make your own simple custom “site plugin” to use locally on your own site and essentially implement the same end effect.  I think this is also a great option if there are other “functions.php” modifications I would want to do later – they can just be done in the site plugin instead!<\/p>\n\n\n\n
\n\n\n\n
Creating your own (basic, empty) site plugin for WordPress is really simple.  On my local system I created a directory named “bdragon-plugin” and created a file inside the directory called “bdragon-plugin.php” – so rename these as you’d prefer but keep the names the same for both! outside of the .php extension.  Basically it looks like this in Windows File Explorer:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Edit the bdragon-plugin.php file in a text editor of your choice, paste in the following for the entire contents of the file – again, change the “bdragon.com” in the name and description to text of your choice:<\/p>\n\n\n\n
<?php\n\/*\nPlugin Name: bdragon.com Site Plugin\nDescription: Site-specific code changes for bdragon.com.\n*\/\n\/* Start Adding Functions Below this Line *\/\n\n\n\n\/* Stop Adding Functions Below this Line *\/\n?>\n<\/code><\/pre>\n\n\n\n
Then you’re going to want to right-click on that main plugin folder (“bdragon-plugin”) and select Send to > Compressed (zipped) folder from the context menu.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Now go to your WordPress Admin area and navigate to Plugins > Add New.  On this screen you should see a button to Upload Plugin near the “Add Plugins” title.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Use this Upload Plugin button to upload the zip file you just created (bdragon-plugin.zip), which should<\/em> create a new site plugin on your site that you can now activate.<\/p>\n\n\n\n
After uploading and activating the plugin you should now be able to navigate to Plugins > Plugin Editor, and click OK on the warning pop-up if you get one.  Pick your newly added site plugin from the drop-down and click the “Select” button.  This should bring up the contents of your plugin’s php file.  In between the “Add Functions Below” and “Stop Adding Functions” line, you can add this line to stop the redirect loop:<\/p>\n\n\n\n
remove_action('template_redirect', 'wp_old_slug_redirect');<\/code><\/pre>\n\n\n\n
The end result will look something like this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Then just click “Update File” and the issue of the endless redirects should now be fixed!  Instead of a redirect error, I now get the WordPress not found error page which looks like this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
<\/p>\n\n\n<\/div>","protected":false},"excerpt":{"rendered":"
Also: An Alternative To Editing functions.php Recently I put up a test post to test the functionality of this site after many updates and upgrades. After I made the post private, I noticed that hitting the URL would not gracefully redirect to an error page or the home page, but instead got stuck in an …<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[177,43],"tags":[186,184,185,191,190,181,180,179,183,188,178,189],"class_list":{"0":"post-584","1":"post","2":"type-post","3":"status-publish","4":"format-standard","6":"category-techie-things","7":"category-web-stuff","8":"tag-action","9":"tag-fix","10":"tag-hook","11":"tag-how-do-i","12":"tag-how-to","13":"tag-post","14":"tag-private","15":"tag-redirects","16":"tag-site-plugin","17":"tag-slugs","18":"tag-wordpress","19":"tag-wordpress-5-6","20":"anons"},"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/peSL2o-9q","jetpack_sharing_enabled":true,"jetpack_likes_enabled":false,"_links":{"self":[{"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/posts\/584","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/comments?post=584"}],"version-history":[{"count":0,"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/posts\/584\/revisions"}],"wp:attachment":[{"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/media?parent=584"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/categories?post=584"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bdragon.com\/lair\/wp-json\/wp\/v2\/tags?post=584"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}