[Content]: Eager Loading should mention what field types and properties benefit/support it
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start from the existing eager-loading documentation; the issue does not name a file or page. Update the relevant content to explain which field types and properties support eager loading, when it improves performance, and whether to include the shown eagerLoadElements() example. Done means these limitations and use cases are clearly documented.
Written by the indexing model from the issue text.
Description
Product
Other/Multiple/Not Sure
Description
We aren't currently explicitly listing the fields and/or properties of elements that can be eager-loaded.
This may have to be "generic," but should still be front-and-center, i.e. "Only properties and custom fields that reference other elements can be eager-loaded."
Additionally, not all fields and/or related elements need to be eager-loaded. We can cover situations where you are apt to see performance improvements vs situations where you won't see any benefit.
This may include a mention of the eager-loading-in-place service method:
{% do craft.app.elements.eagerLoadElements(
className(entry),
[entry],
[
...
]
) %}
- Dominant language
- JavaScript
- Stars
- 42
- Forks
- 160
- Avg merge
- 3h 9m
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from craftcms/docs
-
Broken Link OpenBroken Link
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
-
Broken Link OpenBroken Link
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
[Broken Link]: Open
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
mksglu/context-mode#1200 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
neondatabase/website#5944 ·
-
module: core
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
bigbluebutton/bigbluebutton#25849 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
jaegertracing/jaeger-ui#4506 ·