Add helper function to eliminate duplicate translation strings

b1ink0 · b1ink0 · commit 6969eaeddc6e · 2025-08-22T18:56:34.000+05:30
diff --git a/plugins/speculation-rules/settings.php b/plugins/speculation-rules/settings.php
@@ -56,6 +56,30 @@ function plsr_get_authentication_labels(): array {
 	);
 }
 
+/**
+ * Returns translated description strings for settings fields.
+ *
+ * @since n.e.x.t
+ *
+ * @param string $field The field name to get description for.
+ * @param bool   $strip_tags Whether to strip HTML tags from the description.
+ * @return string The translated description string.
+ */
+function plsr_get_field_description( string $field, bool $strip_tags = false ): string {
+	$descriptions = array(
+		'mode'           => __( 'Prerendering will lead to faster load times than prefetching. However, in case of interactive content, prefetching may be a safer choice.', 'speculation-rules' ),
+		'eagerness'      => __( 'The eagerness setting defines the heuristics based on which the loading is triggered. "Eager" will have the minimum delay to start speculative loads, "Conservative" increases the chance that only URLs the user actually navigates to are loaded.', 'speculation-rules' ),
+		'authentication' => sprintf(
+			/* translators: %s: URL to persistent object cache documentation */
+			__( 'Only unauthenticated pages are typically served from cache. So in order to reduce load on the server, speculative loading is not enabled by default for logged-in users. If your server can handle the additional load, you can opt in to speculative loading for all logged-in users or just administrator users only. For optimal performance when enabling authenticated user support, ensure you have a <a href="%s" target="_blank">persistent object cache</a> configured. This only applies to pages on frontend; admin screens remain excluded.', 'speculation-rules' ),
+			'https://developer.wordpress.org/advanced-administration/performance/optimization/#object-caching'
+		),
+	);
+	$description  = $descriptions[ $field ] ?? '';
+
+	return $strip_tags ? wp_strip_all_tags( $description ) : $description;
+}
+
 /**
  * Returns the default setting value for Speculative Loading configuration.
  *
@@ -153,17 +177,17 @@ function plsr_register_setting(): void {
 					'type'                 => 'object',
 					'properties'           => array(
 						'mode'           => array(
-							'description' => __( 'Whether to prefetch or prerender URLs.', 'speculation-rules' ),
+							'description' => plsr_get_field_description( 'mode', true ),
 							'type'        => 'string',
 							'enum'        => array_keys( plsr_get_mode_labels() ),
 						),
 						'eagerness'      => array(
-							'description' => __( 'The eagerness setting defines the heuristics based on which the loading is triggered. "Eager" will have the minimum delay to start speculative loads, "Conservative" increases the chance that only URLs the user actually navigates to are loaded.', 'speculation-rules' ),
+							'description' => plsr_get_field_description( 'eagerness', true ),
 							'type'        => 'string',
 							'enum'        => array_keys( plsr_get_eagerness_labels() ),
 						),
 						'authentication' => array(
-							'description' => __( 'Only unauthenticated pages are typically served from cache. So in order to reduce load on the server, speculative loading is not enabled by default for logged-in users. If your server can handle the additional load, you can opt in to speculative loading for all logged-in users or just administrator users only. For optimal performance when enabling authenticated user support, ensure you have a persistent object cache configured. This only applies to pages on frontend; admin screens remain excluded.', 'speculation-rules' ),
+							'description' => plsr_get_field_description( 'authentication', true ),
 							'type'        => 'string',
 							'enum'        => array_keys( plsr_get_authentication_labels() ),
 						),
@@ -203,19 +227,15 @@ static function (): void {
 	$fields = array(
 		'mode'           => array(
 			'title'       => __( 'Speculation Mode', 'speculation-rules' ),
-			'description' => __( 'Prerendering will lead to faster load times than prefetching. However, in case of interactive content, prefetching may be a safer choice.', 'speculation-rules' ),
+			'description' => plsr_get_field_description( 'mode' ),
 		),
 		'eagerness'      => array(
 			'title'       => __( 'Eagerness', 'speculation-rules' ),
-			'description' => __( 'The eagerness setting defines the heuristics based on which the loading is triggered. "Eager" will have the minimum delay to start speculative loads, "Conservative" increases the chance that only URLs the user actually navigates to are loaded.', 'speculation-rules' ),
+			'description' => plsr_get_field_description( 'eagerness' ),
 		),
 		'authentication' => array(
 			'title'       => __( 'User Authentication Status', 'speculation-rules' ),
-			'description' => sprintf(
-				/* translators: %s: URL to persistent object cache documentation */
-				__( 'Only unauthenticated pages are typically served from cache. So in order to reduce load on the server, speculative loading is not enabled by default for logged-in users. If your server can handle the additional load, you can opt in to speculative loading for all logged-in users or just administrator users only. For optimal performance when enabling authenticated user support, ensure you have a <a href="%s" target="_blank">persistent object cache</a> configured. This only applies to pages on frontend; admin screens remain excluded.', 'speculation-rules' ),
-				'https://developer.wordpress.org/advanced-administration/performance/optimization/#object-caching'
-			),
+			'description' => plsr_get_field_description( 'authentication' ),
 		),
 	);
 	foreach ( $fields as $slug => $args ) {
