From 06760600505d25ff537e18c9ebe2fe493fb45402 Mon Sep 17 00:00:00 2001 From: Yuri Salimovskiy Date: Sat, 21 Sep 2024 15:07:44 +0300 Subject: [PATCH] Ability to exclude offline sites from `exp:channel:entries` output; #2895 --- docs/add-ons/rss.md | 7 +++++++ docs/add-ons/search/advanced.md | 6 ++++++ docs/add-ons/search/simple.md | 6 ++++++ docs/channels/archive-months.md | 6 ++++++ docs/channels/calendar.md | 7 +++++++ docs/channels/categories.md | 6 ++++++ docs/channels/category-archive.md | 7 +++++++ docs/channels/entries.md | 6 ++++++ docs/channels/entry-linking.md | 6 ++++++ docs/fieldtypes/relationships.md | 1 + 10 files changed, 58 insertions(+) diff --git a/docs/add-ons/rss.md b/docs/add-ons/rss.md index 549791ba..b9cb30e0 100755 --- a/docs/add-ons/rss.md +++ b/docs/add-ons/rss.md @@ -48,6 +48,13 @@ You can determine whether you wish for entries that have "expired" to be include You can determine whether you wish for entries dated in the "future" to be included. This option is useful when doing things like creating a list of events, some of which have not occurred yet. Note that EE will still display past entries; this parameter simply instructs EE to also include entries from the future. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + + ### `status=` status="open" diff --git a/docs/add-ons/search/advanced.md b/docs/add-ons/search/advanced.md index 76207ca6..64463489 100755 --- a/docs/add-ons/search/advanced.md +++ b/docs/add-ons/search/advanced.md @@ -219,6 +219,12 @@ You may also let the user choose by using an Include Future Entries form field. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + ### `site=` site="default_site" diff --git a/docs/add-ons/search/simple.md b/docs/add-ons/search/simple.md index 664183b6..f315f1d0 100755 --- a/docs/add-ons/search/simple.md +++ b/docs/add-ons/search/simple.md @@ -125,6 +125,12 @@ With this parameter you can specify whether or not expired entries will be inclu With this parameter you can specify whether or not entries with the date set in the future will be included in search results. The default behavior is for future entries to _not_ be included. You may set this parameter to "yes" or "no". You may also let the user choose by using an [Include Future Entries](#include-future-entries) form field. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + ### `site=` site="default_site" diff --git a/docs/channels/archive-months.md b/docs/channels/archive-months.md index 98b06850..f6afaec5 100755 --- a/docs/channels/archive-months.md +++ b/docs/channels/archive-months.md @@ -61,6 +61,12 @@ You can determine whether you wish for entries that have "expired" to be include You can determine whether you wish for entries dated in the "future" to be included. This option is useful when doing things like creating a list of events, some of which have not occurred yet. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + ### `status=` status="open" diff --git a/docs/channels/calendar.md b/docs/channels/calendar.md index 4a98c764..625fb852 100755 --- a/docs/channels/calendar.md +++ b/docs/channels/calendar.md @@ -126,6 +126,13 @@ You may hardcode the month and year to display for the calendar. You **must** sp You can determine whether you wish for entries dated in the "future" to be included. This option is useful when doing things like creating a list of events, some of which have not occurred yet. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + + ### `start_day=` start_day="sunday" diff --git a/docs/channels/categories.md b/docs/channels/categories.md index 79871b70..74e21b85 100755 --- a/docs/channels/categories.md +++ b/docs/channels/categories.md @@ -152,6 +152,12 @@ Determines whether entries dated in the "future" to are included when calculatin By default, future dated entries will **not** count when determining whether a category is empty. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + ### `status=` status="open" diff --git a/docs/channels/category-archive.md b/docs/channels/category-archive.md index 6cdca6b4..b02f113b 100755 --- a/docs/channels/category-archive.md +++ b/docs/channels/category-archive.md @@ -168,6 +168,13 @@ By default, categories with no entries **will** be included. You can determine whether you wish for entries dated in the "future" to be included. This option is useful when doing things like creating a list of events, some of which have not occurred yet. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + + ### `sort=` sort="asc" diff --git a/docs/channels/entries.md b/docs/channels/entries.md index 55db4c3b..9bba2dca 100755 --- a/docs/channels/entries.md +++ b/docs/channels/entries.md @@ -608,6 +608,12 @@ There are three valid options for this parameter: "yes", "no", "only". The defau You can determine whether you wish for entries dated in the "future" to be included. This option is useful when doing things like creating a list of events, some of which have not occurred yet. Note that EE will still display past entries; this parameter simply instructs EE to also include entries from the future. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + ### `show_pages=` show_pages="only" show_pages="no" diff --git a/docs/channels/entry-linking.md b/docs/channels/entry-linking.md index 2ac2514f..82ca4d06 100755 --- a/docs/channels/entry-linking.md +++ b/docs/channels/entry-linking.md @@ -107,6 +107,12 @@ You can determine whether you wish for entries that have "expired" to be include You can determine whether you wish for entries dated in the "future" to be included. This option is useful when doing things like creating a list of events, some of which have not occurred yet. +### `show_offline_sites=` + + show_offline_sites="no" + +When this option is set to "no", entries from MSM sites that are set to "offline" will not be included in the results. The default is "yes", which includes entries from offline sites. + ### `status=` status="open" diff --git a/docs/fieldtypes/relationships.md b/docs/fieldtypes/relationships.md index e5506caf..1738550a 100755 --- a/docs/fieldtypes/relationships.md +++ b/docs/fieldtypes/relationships.md @@ -99,6 +99,7 @@ The following parameters are available to all looping relationship tags, allowin - `orderby` - `show_expired` - `show_future_entries` +- `show_offline_sites` - `sort` - `start_on` - `status`