Document embedded object support in comments/comment responses (#185)
authorMatthias Schmidt <gravatronics@live.com>
Thu, 10 Jun 2021 07:25:51 +0000 (09:25 +0200)
committerGitHub <noreply@github.com>
Thu, 10 Jun 2021 07:25:51 +0000 (09:25 +0200)
See WoltLab/WCF#4275

docs/migration/wsc54/php.md

index 518ddd3e4f7467f0c38068d7f44a4d55f1376b19..159816d7e0305143cff907dfe1587a5324cf0b51 100644 (file)
@@ -150,3 +150,10 @@ final class ValueDumpListener implements IParameterizedEventListener
 ) }}
 
 See [WoltLab/WCF#4000](https://github.com/WoltLab/WCF/pull/4000) and [WoltLab/WCF#4265](https://github.com/WoltLab/WCF/pull/4265) for details.
+
+
+## Embedded Objects in Comments
+
+[WoltLab/WCF#4275](https://github.com/WoltLab/WCF/pull/4275) added support for embedded objects like mentions for comments and comment responses.
+To properly render embedded objects whenever you are using comments in your packages, you have to use `ViewableCommentList`/`ViewableCommentResponseList` in these places or `ViewableCommentRuntimeCache`/`ViewableCommentResponseRuntimeCache`.
+While these runtime caches are only available since version 5.5, the viewable list classes have always been available so that changing `CommentList` to `ViewableCommentList`, for example, is a backwards-compatible change.