automattic / rewrite-rules-inspector Goto Github PK

View Code? Open in Web Editor NEW

132.0 128.0 23.0 711 KB

WordPress plugin to inspect your rewrite rules.

Home Page: https://wordpress.org/plugins/rewrite-rules-inspector/

License: GNU General Public License v2.0

PHP 100.00%

wordpress-plugin wordpress wpvip-plugin

rewrite-rules-inspector's Introduction

Rewrite Rules Inspector

Stable tag: 1.3.1
Requires at least: 3.1
Tested up to: 5.7
Requires PHP: 5.6
License: GPLv2 or later
Tags: rewrite rules, tools
Contributors: danielbachhuber, automattic, tmoorewp, GaryJ

A simple admin tool for inspecting rewrite rules.

Description

A simple WordPress admin tool for inspecting rewrite rules. View a listing of all your rewrite rules, see which rewrite rules match a given URL (and the priorites they match in), or filter by different sources of rewrite rules. Perform a soft flush of your rewrite rules to regenerate them.

Originally developed for clients hosted at WordPress VIP, we thought it would be useful for development environments, etc. too. Feel free to fork the plugin in GitHub — pull requests are always welcome. Hit us with feedback, questions, bug reports, and feature requests in the GitHub issues.

Installation

Install the plugin from within WordPress

Visit the Plugins page from your WordPress dashboard and click "Add New" at the top of the page.
Search for "rewrite-rules-inspector" using the search bar on the right side.
Click "Install Now" to install the plugin.
After it's installed, click "Activate" to activate the plugin on your site.

Install the plugin manually

Download the plugin from WordPress.org or get the latest release from our Github Releases page.
Unzip the downloaded archive.
Upload the entire rewrite-rules-inspector folder to your /wp-content/plugins directory.
Visit the Plugins page from your WordPress dashboard and look for the newly installed plugin.
Click "Activate" to activate the plugin on your site.

Screenshots

See which rewrite rules match a given URL, and the priorities they match in.
An error message appears if rewrite rules are missing in the database

Changelog

See the change log.

rewrite-rules-inspector's People

Contributors

Stargazers

Watchers

rewrite-rules-inspector's Issues

Flush doesn't flush

Hi guys, and thanks for your very handy tool.
That helped find me why my sitemap.xml were missing.
As you can see from this screenshot
http://cl.ly/403L3J2j390X2t2Y3R1n
where I have missing rules with the plugin
"BWP Google XML Sitemaps" and from this screenshot
http://cl.ly/0f040v3S3C292T2o0q07
where the plugin is "Google XML Sitemap".

I try to flush but the problem is still there.
Any idea on that? Or where to go from there?

Thanks,

how to use it

hi! i downloaded plugin from github and successfully activated it but i cannot find its settings nor rewrite rules output messages in admin

Support all sources of rewrite rules

We need to support the extra permastructs too.

Plugin uses deprecated screen_icon function

Hi. The plugin uses a function screen_icon which was deprecated long ago – https://developer.wordpress.org/reference/functions/screen_icon/
get_screen_icon should be used instead.
This leeds to PHP notice being thrown when Rewrite Rules page is opened:
Deprecated: get_screen_icon is <strong>deprecated</strong> since version 3.8.0 with no alternative available. in /wp-includes/functions.php on line 4869

Add GitHub Actions for pushing to WordPress.org SVN

This will make it simpler to make new releases.

See and use https://github.com/10up/action-wordpress-plugin-deploy

Inspector displays '^show/$' as matching to request `/show/`, but frontend 404-s

Correct matching string would actually be '^show/?$', or '^show$'. Note the issue with the trailing slash. Is this a bug with the Inspector?

Add a filter to allow modification of rewrite rule source

Prepare a readme

Prepare a quick readme describing how the plugin works.

Indicate missing rewrite rules

If a custom post type was registered or similar, but the rewrite rule is missing in the rewrite rules values, we should indicate as such.

Remove echo on 319

No need to use "echo" with "_e()". It does that already :)

List out permastructs

It would be useful if the rewrite rules page listed out all the various permastructs that WordPress is aware of like post permalink, category, tag, etc.

PHP strict on PHP 5.4.x

PHP 5.4.x is throwing a strict like this:

Declaration of Rewrite_Rules_Inspector_List_Table::single_row() should be compatible with WP_List_Table::single_row($item) on line 298 in file /var/www/clients/client1/web1/web/wp-content/plugins/rewrite-rules-inspector/rewrite-rules-inspector.php

Flushing does not flush missing rules

I've installed the plugin, but hitting the "Flush Rules" button just brings up the same screen that says:

Rewrite rules flushed.

Some rewrite rules may be missing, try flushing.

And all the missing rules re-appear...

No success message is displayed after flushing

After you flush the rules, you're redirected to &message=flush-success but this doesn't actually display a success message so you're left wondering if it worked or not.

Rules with negative lookarounds will never match the test.

Negative lookaheads (?!lookahead) and negative lookbehinds (?<!lookbehind) use the ! character. Because it's the one used as a delimiter in the tests, using them in your rules will break the regex.