New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update plugin names and descriptions to better describe their features #1101
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3e68877
Rename plugins and update descriptions according to #1046.
felixarntz 0c04a92
Add readme.txt explainers about previous plugin names.
felixarntz 6a825c9
Merge branch 'cleanup/module-references' into update/1046-plugin-names
felixarntz 6e017cd
Merge branch 'trunk' into update/1046-plugin-names
felixarntz File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
=== Speculation Rules === | ||
=== Speculative Loading === | ||
|
||
Contributors: wordpressdotorg | ||
Requires at least: 6.4 | ||
|
@@ -9,15 +9,15 @@ License: GPLv2 or later | |
License URI: https://www.gnu.org/licenses/gpl-2.0.html | ||
Tags: performance, javascript, speculation rules, prerender, prefetch | ||
|
||
Uses the Speculation Rules API to prerender linked URLs upon hover by default. | ||
Enables browsers to speculatively prerender or prefetch pages when hovering over links. | ||
|
||
== Description == | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto above about mentioning the old name. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in 0c04a92 |
||
This plugin adds support for the [Speculation Rules API](https://developer.mozilla.org/en-US/docs/Web/API/Speculation_Rules_API), which allows defining rules by which certain URLs are dynamically prefetched or prerendered based on user interaction. | ||
|
||
See the [Speculation Rules WICG specification draft](https://wicg.github.io/nav-speculation/speculation-rules.html). | ||
|
||
By default, the plugin is configured to prerender WordPress frontend URLs when the user hovers over a relevant link. This can be customized via the "Speculation Rules" section under _Settings > Reading_. | ||
By default, the plugin is configured to prerender WordPress frontend URLs when the user hovers over a relevant link. This can be customized via the "Speculative Loading" section under _Settings > Reading_. | ||
|
||
A filter can be used to exclude certain URL paths from being eligible for prefetching and prerendering (see FAQ section). Alternatively, you can add the 'no-prerender' CSS class to any link (`<a>` tag) that should not be prerendered. | ||
|
||
|
@@ -30,19 +30,21 @@ Other browsers will not see any adverse effects, however the feature will not wo | |
* [Browser support for the Speculation Rules API in general](https://caniuse.com/mdn-html_elements_script_type_speculationrules) | ||
* [Information on document rules syntax support used by the plugin](https://developer.chrome.com/blog/chrome-121-beta#speculation_rules_api) | ||
|
||
_This plugin was formerly known as Speculation Rules._ | ||
|
||
== Installation == | ||
|
||
= Installation from within WordPress = | ||
|
||
1. Visit **Plugins > Add New**. | ||
2. Search for **Speculation Rules**. | ||
3. Install and activate the **Speculation Rules** plugin. | ||
2. Search for **Speculative Loading**. | ||
3. Install and activate the **Speculative Loading** plugin. | ||
|
||
= Manual installation = | ||
|
||
1. Upload the entire `speculation-rules` folder to the `/wp-content/plugins/` directory. | ||
2. Visit **Plugins**. | ||
3. Activate the **Speculation Rules** plugin. | ||
3. Activate the **Speculative Loading** plugin. | ||
|
||
== Frequently Asked Questions == | ||
|
||
|
@@ -103,6 +105,7 @@ Contributions are always welcome! Learn more about how to get involved in the [C | |
= 1.1.0 = | ||
|
||
* Allow excluding URL patterns from prerendering or prefetching specifically. ([1025](https://github.com/WordPress/performance/pull/1025)) | ||
* Rename plugin to "Speculative Loading". ([1101](https://github.com/WordPress/performance/pull/1101)) | ||
* Add Speculative Loading generator tag. ([1102](https://github.com/WordPress/performance/pull/1102)) | ||
* Bump minimum required WP version to 6.4. ([1062](https://github.com/WordPress/performance/pull/1062)) | ||
* Update tested WordPress version to 6.5. ([1027](https://github.com/WordPress/performance/pull/1027)) | ||
|
@@ -115,4 +118,4 @@ Contributions are always welcome! Learn more about how to get involved in the [C | |
|
||
= 1.0.0 = | ||
|
||
* Initial release of the Speculation Rules plugin as a standalone plugin. ([733](https://github.com/WordPress/performance/pull/733)) | ||
* Initial release of the Speculative Loading plugin as a standalone plugin. ([733](https://github.com/WordPress/performance/pull/733)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps the first line of the description should say:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@westonruter How about putting those explanations at the end of the respective
== Description ==
section?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in 0c04a92