Skip to content

Update the disable documentation in two places #1085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: 7.dev
Choose a base branch
from
Open

Update the disable documentation in two places #1085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dcc4e58
Update entries.md with additional disable notes
nep Nov 5, 2025
fd895b6
Improve clarity on optimizing relationship field performance
nep Nov 5, 2025
07d6202
Merge pull request #5 from nep/nep-patch-1-1
nep Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/channels/entries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ The syntax for the disable parameter is this: `disable="ITEM YOU WANT TO DISABLE
- `relationship_custom_fields`
- `relationship_categories`

NOTE: **Note:** If you disable categories, category fields will automatically be disabled.
NOTE: **Note:** If you disable categories, category fields will automatically be disabled. If you disable custom_fields, that includes relationships. If you disable relationships, [relationship_custom_fields and relationship_categories](fieldtypes/relationships.md#optimizing-relationships-performance) will automatically be disabled.

You may specify multiple items to disable by separating them with the pipe character:

Expand All @@ -191,7 +191,7 @@ For example, let's say you are using an instance of your channel tag to show you
<a href="{title_permalink='channel/comments'}">{title}</a><br>
{/exp:channel:entries}

In this example you are only showing the title of your entries and nothing else; yet, the channel tag automatically fetches categories and other data. Using the disable= parameter you can turn off the unneeded features from being queried. In this case, you don't need any of the features that can be disabled.
In this example you are only showing the title of your entries and nothing else; yet, the channel tag automatically fetches categories and other data. Using the disable= parameter you can turn off the unneeded features from being queried. In this case, you don't need any of the features and they all can be disabled.

{exp:channel:entries orderby="date" sort="desc" limit="10" disable="categories|custom_fields|member_data|pagination"}
<a href="{title_permalink='channel/comments'}">{title}</a><br>
Expand Down
2 changes: 1 addition & 1 deletion docs/fieldtypes/relationships.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ Would output in the format:

## Optimizing Relationships Performance

If you are heavily using relationship fields, it is recommended that you disable certain features, such as custom fields or categories on related entries, to speed up template loading. That can be done by applying `disable` parameter to the `exp:channel:entries` tag that includes relationship field tag (or siblings / parents tag).
If you are heavily using relationship fields, it is recommended that you disable certain features such as custom fields or categories on the related entries to speed up template loading. That can be done by applying the [`disable` parameter](/channels/entries.md#disable) to the `exp:channel:entries` tag that includes the relationship field tag (or siblings / parents tag).

The following items can be turned off:

Expand Down