[Content]: Revise "Extending Twig" > "Registering the Extension"
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 68/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- php
- Área
- documentation
Línea de trabajo
Comienza con la sección “Registering the Extension” enlazada en el issue y revisa el código fuente de la documentación correspondiente. Revisa el contexto relacionado con CKEditor descrito en los issues enlazados y, después, actualiza la guía para que explique con precisión cuándo es apropiado comprobar getIsSiteRequest(); la sección debe reflejar claramente el comportamiento de registro compatible.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Product
Craft CMS
Description
The docs mention this code in order to register Twig extensions:
if (Craft::$app->getRequest()->getIsSiteRequest()) {
// Instantiate + register the extension:
$extension = new mynamespace\myplugin\twig\Extension();
Craft::$app->getView()->registerTwigExtension($extension);
}
And then states:
The
getIsSiteRequest()check is optional. If your extension provides features that will be useful in system emails (commonly triggered from the control panel), or will be used when rendering templates from console requests (less common, but still valid), you may want to register it in all contexts.
However, since Craft 4.2.0 custom Twig functions are also used in CKEditor if it renders deeply nested partial templates that include CKEditor themselves. This results in issues like https://github.com/craftcms/ckeditor/issues/248 and https://github.com/craftcms/cms/issues/19639 (and I've also been asking for more context on this matter in https://github.com/craftcms/ckeditor/discussions/627). That's why I'd consider the getIsSiteRequest() check as actually harmful in Twig extension modules because now there are quite a few cases where Twig extensions are required in the CP as well.
Either this should get mentioned in the docs or the check should get removed completely (assuming the behavior of CKEditor doesn't change).
- Lenguaje dominante
- JavaScript
- Estrellas
- 43
- Forks
- 160
- Merge medio
- 3 h 9 min
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de craftcms/docs
-
Broken LinkAbiertoBroken Link
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
[Content]: Sequel Pro referenceAbierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 68/100
-
Broken LinkAbiertoBroken Link
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
[Broken Link]:Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
Todos los issues de craftcms/docs
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
Los mantenedores suelen responder en 1 día
-
curriculum documentation quality
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
githubnext/gh-aw-workshop#3897 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 1 día
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 91/100
Los mantenedores suelen responder en 1 día