Indicate deprecated nature of url_metrics_group_collection property

WordPress · Oct 3, 2024 · 5960ff3 · 5960ff3
1 parent 1cf24f1
commit 5960ff3
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/plugins/optimization-detective/class-od-tag-visitor-context.php b/plugins/optimization-detective/class-od-tag-visitor-context.php
@@ -17,7 +17,7 @@
  * @since 0.4.0
  * @access private
  *
- * @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection
+ * @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection Deprecated property accessed via magic getter. Use the url_metric_group_collection property instead.
  */
 final class OD_Tag_Visitor_Context {
 
@@ -59,7 +59,10 @@ public function __construct( OD_HTML_Tag_Processor $processor, OD_URL_Metric_Gro
 	}
 
 	/**
-	 * Gets magic properties.
+	 * Gets deprecated property.
+	 *
+	 * @since n.e.x.t
+	 * @todo Remove this when no plugins are possibly referring to the url_metrics_group_collection property anymore.
 	 *
 	 * @param string $name Property name.
 	 * @return OD_URL_Metric_Group_Collection URL metric group collection.