Skip to content

Docs for primary_role_id param #650

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

Merged
merged 2 commits into from
Feb 12, 2024
Merged

Docs for primary_role_id param #650

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
169538d
Docs for `primary_role_id` param
intoeetive May 8, 2023
1f22d88
Update entries.md
bryannielsen Feb 8, 2024
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
16 changes: 15 additions & 1 deletion docs/channels/entries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,13 +309,15 @@ NOTE: **Note:** Using this parameter will automatically constrain the entries ta

### `group_id=`

NOTE: We recommend using [primary_role_id=](#primary_role_id) parameter instead, which works the same but more clearly conveys that the filtering is happening on primary role ID.

group_id="4"

You can decide from which Member Role (by specifying the role ID) you wish entries to be shown. If you choose "4", then only entries created by members of the Primary Role with the ID of 4 will be shown. You can choose multiple Roles using a pipe:

group_id="2|3|4"

Or exclude groups using "not"
Or exclude role using "not"

group_id="not 2|3|4"

Expand Down Expand Up @@ -436,6 +438,18 @@ This tells ExpressionEngine to override the normal [pagination](templates/pagina

This tells ExpressionEngine to function in "pagination" mode for your channel entry fields so that you can automatically have an entry span multiple pages. See the [Spanning a Channel Entry Across Multiple Pages](channels/entry-spanning.md) page.

### `primary_role_id=`

primary_role_id="4"

You can decide from which Member Role (by specifying the role ID) you wish entries to be shown. If you choose "4", then only entries created by members of the Primary Role with the ID of 4 will be shown. You can choose multiple Roles using a pipe:

primary_role_id="2|3|4"

Or exclude roles using "not"

primary_role_id="not 2|3|4"

### `related_categories_mode=`

related_categories_mode="no" related_categories_mode="yes"
Expand Down