Skip to content
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 4 commits into from Mar 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Expand Up @@ -20,15 +20,15 @@
/plugins/auto-sizes @joemcgill
/tests/plugins/auto-sizes @joemcgill

# Plugin: Speculation Rules
# Plugin: Speculative Loading
/plugins/speculation-rules @felixarntz
/tests/plugins/speculation-rules @felixarntz

# Plugin: WebP Uploads
# Plugin: Modern Image Formats
/plugins/webp-uploads @adamsilverstein @felixarntz
/tests/plugins/webp-uploads @adamsilverstein @felixarntz

# Plugin: Dominant Color Images
# Plugin: Image Placeholders
/plugins/dominant-color-images @pbearne @spacedmonkey
/tests/plugins/dominant-color-images @pbearne @spacedmonkey

Expand Down
2 changes: 1 addition & 1 deletion plugins/auto-sizes/auto-sizes.php
Expand Up @@ -2,7 +2,7 @@
/**
* Plugin Name: Auto-sizes for Lazy-loaded Images
* Plugin URI: https://github.com/WordPress/performance/tree/trunk/plugins/auto-sizes
* Description: This plugin implements the HTML spec for adding <code>sizes="auto"</code> to lazy-loaded images.
* Description: Instructs browsers to automatically choose the right image size for lazy-loaded images.
* Requires at least: 6.4
* Requires PHP: 7.0
* Version: 1.0.1
Expand Down
2 changes: 1 addition & 1 deletion plugins/auto-sizes/readme.txt
Expand Up @@ -9,7 +9,7 @@ License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Tags: performance, images, auto-sizes

Adds support for automatically calculating the sizes attribute for lazy-loaded images.
Instructs browsers to automatically choose the right image size for lazy-loaded images.

== Description ==

Expand Down
2 changes: 1 addition & 1 deletion plugins/dominant-color-images/helper.php
@@ -1,6 +1,6 @@
<?php
/**
* Helper functions used for Dominant Color Images.
* Helper functions used for Image Placeholders.
*
* @package dominant-color-images
*
Expand Down
6 changes: 3 additions & 3 deletions plugins/dominant-color-images/hooks.php
@@ -1,6 +1,6 @@
<?php
/**
* Hook callbacks used for Dominant Color Images.
* Hook callbacks used for Image Placeholders.
*
* @package dominant-color-images
*
Expand Down Expand Up @@ -171,13 +171,13 @@ function dominant_color_add_inline_style() {
add_filter( 'wp_enqueue_scripts', 'dominant_color_add_inline_style' );

/**
* Displays the HTML generator tag for the Dominant Color Images plugin.
* Displays the HTML generator tag for the Image Placeholders plugin.
*
* See {@see 'wp_head'}.
*
* @since 1.0.0
*/
function dominant_color_render_generator() {
echo '<meta name="generator" content="Dominant Color Images ' . esc_attr( DOMINANT_COLOR_IMAGES_VERSION ) . '">' . "\n";
echo '<meta name="generator" content="Image Placeholders ' . esc_attr( DOMINANT_COLOR_IMAGES_VERSION ) . '">' . "\n";
}
add_action( 'wp_head', 'dominant_color_render_generator' );
8 changes: 4 additions & 4 deletions plugins/dominant-color-images/load.php
@@ -1,11 +1,11 @@
<?php
/**
* Plugin Name: Dominant Color Images
* Plugin Name: Image Placeholders
* Plugin URI: https://github.com/WordPress/performance/tree/trunk/plugins/dominant-color-images
* Description: Adds support to store the dominant color of newly uploaded images and create a placeholder background of that color.
* Description: Displays placeholders based on an image's dominant color while the image is loading.
* Requires at least: 6.4
* Requires PHP: 7.0
* Version: 1.0.2
* Version: 1.1.0
* Author: WordPress Performance Team
* Author URI: https://make.wordpress.org/performance/
* License: GPLv2 or later
Expand All @@ -25,7 +25,7 @@
return;
}

define( 'DOMINANT_COLOR_IMAGES_VERSION', '1.0.2' );
define( 'DOMINANT_COLOR_IMAGES_VERSION', '1.1.0' );

require_once __DIR__ . '/helper.php';
require_once __DIR__ . '/hooks.php';
2 changes: 1 addition & 1 deletion plugins/dominant-color-images/phpcs.xml.dist
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<ruleset name="WPP-DominantColorImages">
<description>WordPress Coding Standards for Dominant Color Images Plugin</description>
<description>WordPress Coding Standards for Image Placeholders Plugin</description>

<rule ref="../../bin/phpcs/phpcs.ruleset.xml"/>

Expand Down
19 changes: 11 additions & 8 deletions plugins/dominant-color-images/readme.txt
@@ -1,33 +1,35 @@
=== Dominant Color Images ===
=== Image Placeholders ===

Contributors: wordpressdotorg
Requires at least: 6.4
Tested up to: 6.5
Requires PHP: 7.0
Stable tag: 1.0.2
Stable tag: 1.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Tags: performance, images, dominant color

Adds support to store the dominant color of newly uploaded images and create a placeholder background of that color.
Displays placeholders based on an image's dominant color while the image is loading.

== Description ==

Copy link
Member

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:

This plugin was formerly known as Dominant Color Images.

Copy link
Member Author

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 0c04a92

This plugin determines and stores the dominant color for newly uploaded images in the media library within WordPress and then uses it to create a placeholder background of that color in the frontend, visible until the image is loaded.

_This plugin was formerly known as Dominant Color Images._

== Installation ==

= Installation from within WordPress =

1. Visit **Plugins > Add New**.
2. Search for **Dominant Color Images**.
3. Install and activate the **Dominant Color Images** plugin.
2. Search for **Image Placeholders**.
3. Install and activate the **Image Placeholders** plugin.

= Manual installation =

1. Upload the entire `dominant-color-images` folder to the `/wp-content/plugins/` directory.
2. Visit **Plugins**.
3. Activate the **Dominant Color Images** plugin.
3. Activate the **Image Placeholders** plugin.

== Frequently Asked Questions ==

Expand All @@ -47,8 +49,9 @@ Contributions are always welcome! Learn more about how to get involved in the [C

== Changelog ==

= 1.0.2 =
= 1.1.0 =

* Rename plugin to "Image Placeholders". ([1101](https://github.com/WordPress/performance/pull/1101))
* 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))

Expand All @@ -58,4 +61,4 @@ Contributions are always welcome! Learn more about how to get involved in the [C

= 1.0.0 =

* Initial release of the Dominant Color Images plugin as a standalone plugin. ([704](https://github.com/WordPress/performance/pull/704))
* Initial release of the Image Placeholders plugin as a standalone plugin. ([704](https://github.com/WordPress/performance/pull/704))
2 changes: 1 addition & 1 deletion plugins/speculation-rules/helper.php
@@ -1,6 +1,6 @@
<?php
/**
* Helper functions used for Speculation Rules.
* Helper functions used for Speculative Loading.
*
* @package speculation-rules
* @since 1.0.0
Expand Down
2 changes: 1 addition & 1 deletion plugins/speculation-rules/hooks.php
@@ -1,6 +1,6 @@
<?php
/**
* Hook callbacks used for Speculation Rules.
* Hook callbacks used for Speculative Loading.
*
* @package speculation-rules
* @since 1.0.0
Expand Down
4 changes: 2 additions & 2 deletions plugins/speculation-rules/load.php
@@ -1,8 +1,8 @@
<?php
/**
* Plugin Name: Speculation Rules
* Plugin Name: Speculative Loading
* Plugin URI: https://github.com/WordPress/performance/tree/trunk/plugins/speculation-rules
* Description: Uses the Speculation Rules API to prerender linked URLs upon hover by default.
* Description: Enables browsers to speculatively prerender or prefetch pages when hovering over links.
* Requires at least: 6.4
* Requires PHP: 7.0
* Version: 1.1.0
Expand Down
2 changes: 1 addition & 1 deletion plugins/speculation-rules/phpcs.xml.dist
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<ruleset name="WPP-SpeculationRules">
<description>WordPress Coding Standards for Speculation Rules Plugin</description>
<description>WordPress Coding Standards for Speculative Loading Plugin</description>

<rule ref="../../bin/phpcs/phpcs.ruleset.xml"/>

Expand Down
17 changes: 10 additions & 7 deletions plugins/speculation-rules/readme.txt
@@ -1,4 +1,4 @@
=== Speculation Rules ===
=== Speculative Loading ===

Contributors: wordpressdotorg
Requires at least: 6.4
Expand All @@ -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 ==

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto above about mentioning the old name.

Copy link
Member Author

Choose a reason for hiding this comment

The 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.

Expand All @@ -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 ==

Expand Down Expand Up @@ -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))
Expand All @@ -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))
18 changes: 9 additions & 9 deletions plugins/speculation-rules/settings.php
@@ -1,6 +1,6 @@
<?php
/**
* Settings functions used for Speculation Rules.
* Settings functions used for Speculative Loading.
*
* @package speculation-rules
* @since 1.0.0
Expand All @@ -12,7 +12,7 @@
}

/**
* Returns the available options for the Speculation Rules mode and their labels.
* Returns the available options for the Speculative Loading mode and their labels.
*
* @since 1.0.0
*
Expand All @@ -26,7 +26,7 @@ function plsr_get_mode_labels() {
}

/**
* Returns the available options for the Speculation Rules eagerness and their labels.
* Returns the available options for the Speculative Loading eagerness and their labels.
*
* @since 1.0.0
*
Expand All @@ -41,7 +41,7 @@ function plsr_get_eagerness_labels() {
}

/**
* Returns the default setting value for Speculation Rules configuration.
* Returns the default setting value for Speculative Loading configuration.
*
* @since 1.0.0
*
Expand All @@ -60,7 +60,7 @@ function plsr_get_setting_default() {
}

/**
* Sanitizes the setting for Speculation Rules configuration.
* Sanitizes the setting for Speculative Loading configuration.
*
* @since 1.0.0
*
Expand Down Expand Up @@ -97,7 +97,7 @@ function plsr_sanitize_setting( $input ) {
}

/**
* Registers setting to control Speculation Rules configuration.
* Registers setting to control Speculative Loading configuration.
*
* @since 1.0.0
* @access private
Expand Down Expand Up @@ -133,15 +133,15 @@ function plsr_register_setting() {
add_action( 'init', 'plsr_register_setting' );

/**
* Adds the settings sections and fields for the Speculation Rules configuration.
* Adds the settings sections and fields for the Speculative Loading configuration.
*
* @since 1.0.0
* @access private
*/
function plsr_add_setting_ui() {
add_settings_section(
'plsr_speculation_rules',
__( 'Speculation Rules', 'speculation-rules' ),
__( 'Speculative Loading', 'speculation-rules' ),
static function () {
?>
<p class="description">
Expand Down Expand Up @@ -179,7 +179,7 @@ static function () {
add_action( 'load-options-reading.php', 'plsr_add_setting_ui' );

/**
* Renders a settings field for the Speculation Rules configuration.
* Renders a settings field for the Speculative Loading configuration.
*
* @since 1.0.0
* @access private
Expand Down
2 changes: 1 addition & 1 deletion plugins/webp-uploads/helper.php
@@ -1,6 +1,6 @@
<?php
/**
* Helper functions used for WebP Uploads.
* Helper functions used for Modern Image Formats.
*
* @package webp-uploads
*
Expand Down
8 changes: 4 additions & 4 deletions plugins/webp-uploads/hooks.php
@@ -1,6 +1,6 @@
<?php
/**
* Hook callbacks used for WebP Uploads.
* Hook callbacks used for Modern Image Formats.
*
* @package webp-uploads
*
Expand Down Expand Up @@ -763,21 +763,21 @@ function webp_uploads_modify_webp_quality( $quality, $mime_type ) {
add_filter( 'wp_editor_set_quality', 'webp_uploads_modify_webp_quality', 10, 2 );

/**
* Displays the HTML generator tag for the WebP Uploads plugin.
* Displays the HTML generator tag for the Modern Image Formats plugin.
*
* See {@see 'wp_head'}.
*
* @since 1.0.0
*/
function webp_uploads_render_generator() {
echo '<meta name="generator" content="WebP Uploads ' . esc_attr( WEBP_UPLOADS_VERSION ) . '">' . "\n";
echo '<meta name="generator" content="Modern Image Formats ' . esc_attr( WEBP_UPLOADS_VERSION ) . '">' . "\n";
}
add_action( 'wp_head', 'webp_uploads_render_generator' );

/**
* Adds a settings link to the plugin's action links.
*
* @since 1.0.6
* @since 1.1.0
*
* @param array $links An array of plugin action links.
* @return array The modified list of actions.
Expand Down