From 7f9a37796792ff8b029485941aac9efccbc8c26b Mon Sep 17 00:00:00 2001 From: Travis 'Nep' Smith Date: Thu, 29 May 2025 16:27:40 -0500 Subject: [PATCH 1/7] Update entries.md Adding search:title and search:url_title Note. --- docs/channels/entries.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/channels/entries.md b/docs/channels/entries.md index d84d40ca7..c26feabc2 100755 --- a/docs/channels/entries.md +++ b/docs/channels/entries.md @@ -496,6 +496,8 @@ The "search:" parameter allows you to constrain Channel Entries output based on NOTE: **Note:** Some fields store their content in a manner that affects the ability to work with this parameter. Grid fields, for instance, could only use this parameter for columns with "Include in search?" enabled. Relationship fields cannot be searched using the search parameter. +NOTE: **Note:** You can also use search:title and search:url_title in addition to searching field content. Remember that it is best to use url_title="something" if you're looking for an exact url_title match. + #### "Exact" Matching Use "Exact" matching when you only want entries whose fields match your terms exactly. To trigger "Exact" matching, precede your search terms with an equal sign (=). You may provide a pipe-delimited list of terms: From c63accd8b79e630f2aca5e6ba54a3c3320c8698f Mon Sep 17 00:00:00 2001 From: Tom Jaeger Date: Fri, 15 Aug 2025 12:54:02 -0400 Subject: [PATCH 2/7] added docs for the file_type param --- docs/add-ons/file.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/add-ons/file.md b/docs/add-ons/file.md index 485ef45c7..13dd00b7e 100755 --- a/docs/add-ons/file.md +++ b/docs/add-ons/file.md @@ -128,6 +128,22 @@ You can hard code the file entries tag to show specific files. You may also spec If you want to display only the files that are in certain folder within an Upload Directory, specify the folder ID using this parameter. +### `file_type=` + + file_type="img|doc" + +Filter returned files by file type group, as classified by the core MIME groups (defined in the mimes configuration). You may specify one or more types; separate multiple values with the pipe character. + +Or use "not" to exclude types: + + file_type="not audio|video" + +Common examples: + +- Images only: `file_type="img"` +- Documents only: `file_type="doc"` + + ### `mime_type=` mime_type="image/jpeg|image/png" From 90db0350b3a072acb011ef19c062e0ac843fb245 Mon Sep 17 00:00:00 2001 From: Travis 'Nep' Smith Date: Mon, 25 Aug 2025 18:00:37 -0500 Subject: [PATCH 3/7] Update entries.md to explain the search: parameter a bit more Link to Pro Search Results as an alternative. --- docs/channels/entries.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/channels/entries.md b/docs/channels/entries.md index 0fd0be80f..f46f5278e 100755 --- a/docs/channels/entries.md +++ b/docs/channels/entries.md @@ -498,7 +498,8 @@ NOTE: **Note:** You will often use this parameter in conjunction with the [if no The "search:" parameter allows you to constrain Channel Entries output based on content within your fields. You specify which field to search by using the field's short name immediately after "search:". You can search based on whether a field is an exact match to your provided term or whether or not a field simply contains your term. -NOTE: **Note:** Some fields store their content in a manner that affects the ability to work with this parameter. Grid fields, for instance, could only use this parameter for columns with "Include in search?" enabled. Relationship fields cannot be searched using the search parameter. +NOTE: **Note:** Some fields store their content in a manner that affects the ability to work with this parameter. Grid fields, for instance, can only use this parameter for columns with "Include in search?" enabled (For performance, EE groups those columns into a searchable blob.). You can, however, search on Grid columns by using Pro Search's [`{exp:pro_search:results}`](add-ons/pro-search/tags.md#exppro_searchresults) tag and the [Field Search filter](/add-ons/pro-search/filters.md#field-search). Pro Search can also be used to filter entries by [title](/add-ons/pro-search/filters.md#searchtitle), [url_title](/add-ons/pro-search/filters.md#searchurltitle), [status](/add-ons/pro-search/filters.md#searchstatus), and [more](/add-ons/pro-search/filters.md#field-search). Relationship fields cannot be searched using the "search:" parameter. + #### "Exact" Matching From 57726cc9cbe2e9547c5eb6b4182f3174d0c5b5c8 Mon Sep 17 00:00:00 2001 From: Travis 'Nep' Smith Date: Mon, 25 Aug 2025 18:06:10 -0500 Subject: [PATCH 4/7] Update filters.md Fixing a broken link --- docs/add-ons/pro-search/filters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/add-ons/pro-search/filters.md b/docs/add-ons/pro-search/filters.md index 2969e4623..98c97b94e 100644 --- a/docs/add-ons/pro-search/filters.md +++ b/docs/add-ons/pro-search/filters.md @@ -235,7 +235,7 @@ You can use the native `search:field_name` parameter to target specific fields. #### `search:field_name` -Like the [channel search:field_name= parameter](/channel/channel_entries.md#search-field-name). +Like the [Channel search:field_name= parameter](/channel/entries.md#searchfield_name). #### `search:field_name:column_name` From 6b9a3026c4bd7ac45676ba8e1cfbb1d54ff916cc Mon Sep 17 00:00:00 2001 From: Tom Jaeger Date: Mon, 15 Sep 2025 12:27:20 -0400 Subject: [PATCH 5/7] small additional change log fix --- docs/installation/changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/changelog.md b/docs/installation/changelog.md index 5c1ba4fd5..818e111e9 100755 --- a/docs/installation/changelog.md +++ b/docs/installation/changelog.md @@ -38,7 +38,7 @@ - Added support for AVIF images in File Manager [#4837](https://github.com/ExpressionEngine/ExpressionEngine/pull/4837) - Made "View Page" link in Structure open in a new tab [#4383](https://github.com/ExpressionEngine/ExpressionEngine/pull/4383) - Changed template no-access language [#4956](https://github.com/ExpressionEngine/ExpressionEngine/pull/4956) -- Added the `backspace` parameter to `{exp:channel:entries}` tag [#4954](https://github.com/ExpressionEngine/ExpressionEngine/pull/4954) +- Added the `backspace` parameter to `{exp:comment:entries}` tag [#4954](https://github.com/ExpressionEngine/ExpressionEngine/pull/4954) - Allowed Upload Destination adapter to be overridden in config [#4946](https://github.com/ExpressionEngine/ExpressionEngine/pull/4946) - Added new CLI commands and JSON output options [#4969](https://github.com/ExpressionEngine/ExpressionEngine/pull/4969) - Added additional HTTP status codes [#4976](https://github.com/ExpressionEngine/ExpressionEngine/pull/4976), including 422 [#4975](https://github.com/ExpressionEngine/ExpressionEngine/pull/4975) From 0a337e7b48ba078df6cfefece586cb4501ba6a54 Mon Sep 17 00:00:00 2001 From: Tom Jaeger Date: Mon, 15 Sep 2025 15:26:29 -0400 Subject: [PATCH 6/7] adding docs for the new cli commands --- docs/cli/built-in-commands/channels-list.md | 72 +++++++++++++ docs/cli/built-in-commands/fields-list.md | 102 ++++++++++++++++++ docs/cli/built-in-commands/fieldtypes-list.md | 82 ++++++++++++++ docs/cli/built-in-commands/version.md | 50 +++++++++ 4 files changed, 306 insertions(+) create mode 100644 docs/cli/built-in-commands/channels-list.md create mode 100644 docs/cli/built-in-commands/fields-list.md create mode 100644 docs/cli/built-in-commands/fieldtypes-list.md create mode 100644 docs/cli/built-in-commands/version.md diff --git a/docs/cli/built-in-commands/channels-list.md b/docs/cli/built-in-commands/channels-list.md new file mode 100644 index 000000000..8bfed6a60 --- /dev/null +++ b/docs/cli/built-in-commands/channels-list.md @@ -0,0 +1,72 @@ +# `channels:list` + +Lists all channels in the system with their details in various formats. + +TIP: If you would like to create or manage channels programmatically, see the Channel Model documentation. + +## php eecli.php channels:list + +### Options list: + +``` + --site= + -s + Site ID to list channels for + + --format= + -f + Output format: table, json, or csv + + --channel_id= + -c + Filter by specific channel ID +``` + +## Examples: + +### Listing all channels: + +The following commands will list all channels in table format (default): + +`php eecli.php channels:list` + +`php eecli.php channels:list --format=table` + +`php eecli.php channels:list -f table` + +### Listing channels for a specific site: + +`php eecli.php channels:list --site=1` + +`php eecli.php channels:list -s 1` + +### Filtering by channel ID: + +`php eecli.php channels:list --channel_id=5` + +`php eecli.php channels:list -c 5` + +### Output in JSON format: + +`php eecli.php channels:list --format=json` + +`php eecli.php channels:list -f json` + +### Output in CSV format: + +`php eecli.php channels:list --format=csv` + +`php eecli.php channels:list -f csv` + +### Combining filters: + +You can combine multiple filters to narrow down your results: + +`php eecli.php channels:list --site=1 --format=json` + +`php eecli.php channels:list -s 1 -c 5 -f table` + +--- + +ExpressionEngine 7 Docs +©2002–2024 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/fields-list.md b/docs/cli/built-in-commands/fields-list.md new file mode 100644 index 000000000..9ed4051e1 --- /dev/null +++ b/docs/cli/built-in-commands/fields-list.md @@ -0,0 +1,102 @@ +# `fields:list` + +Lists all channel fields in the system with their details in various formats. + +TIP: If you would like to create or manage channel fields programmatically, see the ChannelField Model documentation. + +## php eecli.php fields:list + +### Options list: + +``` + --site= + -s + Site ID to list fields for + + --format= + -f + Output format: table, json, or csv + + --type= + -t + Filter by field type (e.g., text, textarea, select) + + --group= + -g + Filter by field group name or short name + + --channel_id= + -c + Filter by channel ID + + --field_id= + -i + Filter by specific field ID +``` + +## Examples: + +### Listing all fields: + +The following commands will list all channel fields in table format (default): + +`php eecli.php fields:list` + +`php eecli.php fields:list --format=table` + +`php eecli.php fields:list -f table` + +### Listing fields for a specific site: + +`php eecli.php fields:list --site=1` + +`php eecli.php fields:list -s 1` + +### Filtering by field type: + +`php eecli.php fields:list --type=text` + +`php eecli.php fields:list -t textarea` + +### Filtering by field group: + +`php eecli.php fields:list --group="Blog Fields"` + +`php eecli.php fields:list -g blog_fields` + +### Filtering by channel ID: + +`php eecli.php fields:list --channel_id=5` + +`php eecli.php fields:list -c 5` + +### Filtering by field ID: + +`php eecli.php fields:list --field_id=10` + +`php eecli.php fields:list -i 10` + +### Output in JSON format: + +`php eecli.php fields:list --format=json` + +`php eecli.php fields:list -f json` + +### Output in CSV format: + +`php eecli.php fields:list --format=csv` + +`php eecli.php fields:list -f csv` + +### Combining filters: + +You can combine multiple filters to narrow down your results: + +`php eecli.php fields:list --site=1 --type=text --format=json` + +`php eecli.php fields:list -s 1 -t select -g blog_fields -f table` + +--- + +ExpressionEngine 7 Docs +©2002–2025 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/fieldtypes-list.md b/docs/cli/built-in-commands/fieldtypes-list.md new file mode 100644 index 000000000..9ad8422d9 --- /dev/null +++ b/docs/cli/built-in-commands/fieldtypes-list.md @@ -0,0 +1,82 @@ +# `fieldtypes:list` + +Lists all available fieldtypes provided by installed and bundled add-ons. + +TIP: If you would like to create custom fieldtypes, see the Fieldtype Development documentation. + +## php eecli.php fieldtypes:list + +### Options list: + +``` + --format= + -f + Output format: table, json, or csv + + --installed + -i + Show only fieldtypes from installed add-ons + + --addon= + -a + Filter by add-on short name(s), comma-separated + + --short= + -s + Filter by fieldtype short name(s), comma-separated +``` + +## Examples: + +### Listing all fieldtypes: + +The following commands will list all available fieldtypes in table format (default): + +`php eecli.php fieldtypes:list` + +`php eecli.php fieldtypes:list --format=table` + +`php eecli.php fieldtypes:list -f table` + +### Listing only installed fieldtypes: + +`php eecli.php fieldtypes:list --installed` + +`php eecli.php fieldtypes:list -i` + +### Filtering by add-on: + +`php eecli.php fieldtypes:list --addon=pro_search` + +`php eecli.php fieldtypes:list -a channel_files,structure` + +### Filtering by fieldtype short name: + +`php eecli.php fieldtypes:list --short=text` + +`php eecli.php fieldtypes:list -s textarea,select,radio` + +### Output in JSON format: + +`php eecli.php fieldtypes:list --format=json` + +`php eecli.php fieldtypes:list -f json` + +### Output in CSV format: + +`php eecli.php fieldtypes:list --format=csv` + +`php eecli.php fieldtypes:list -f csv` + +### Combining filters: + +You can combine multiple filters to narrow down your results: + +`php eecli.php fieldtypes:list --installed --addon=pro_search --format=json` + +`php eecli.php fieldtypes:list -i -s text,textarea -f table` + +--- + +ExpressionEngine 7 Docs +©2002–2025 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/version.md b/docs/cli/built-in-commands/version.md new file mode 100644 index 000000000..94e07990b --- /dev/null +++ b/docs/cli/built-in-commands/version.md @@ -0,0 +1,50 @@ +# `version` + +Shows the current ExpressionEngine version and system information. + +TIP: If you would like to check version information programmatically, see the Config Service documentation. + +## php eecli.php version + +### Options list: + +``` + --format= + -f + Output format: simple, or json + + --field= + -e + Output only a specific field: version, build, or php_version +``` + +## Examples: + +### Showing version information: + +The following commands will show ExpressionEngine version information in simple format (default): + +`php eecli.php version` + +`php eecli.php version --format=simple` + +`php eecli.php version -f simple` + +### Output in JSON format: + +`php eecli.php version --format=json` + +`php eecli.php version -f json` + +### Getting specific field values: + +`php eecli.php version --field=version` + +`php eecli.php version -e build` + +`php eecli.php version --field=php_version` + +--- + +ExpressionEngine 7 Docs +©2002–2025 Packet Tide,LLC. Edit this page From 7dbfa1cc1f0d2a2539d3dfcc81996a98e5d8b295 Mon Sep 17 00:00:00 2001 From: Tom Jaeger Date: Mon, 15 Sep 2025 15:28:52 -0400 Subject: [PATCH 7/7] removing footer elements. --- docs/cli/built-in-commands/channels-list.md | 7 +------ docs/cli/built-in-commands/fields-list.md | 7 +------ docs/cli/built-in-commands/fieldtypes-list.md | 5 ----- docs/cli/built-in-commands/version.md | 5 ----- 4 files changed, 2 insertions(+), 22 deletions(-) diff --git a/docs/cli/built-in-commands/channels-list.md b/docs/cli/built-in-commands/channels-list.md index 8bfed6a60..d76c52361 100644 --- a/docs/cli/built-in-commands/channels-list.md +++ b/docs/cli/built-in-commands/channels-list.md @@ -64,9 +64,4 @@ You can combine multiple filters to narrow down your results: `php eecli.php channels:list --site=1 --format=json` -`php eecli.php channels:list -s 1 -c 5 -f table` - ---- - -ExpressionEngine 7 Docs -©2002–2024 Packet Tide,LLC. Edit this page +`php eecli.php channels:list -s 1 -c 5 -f table` \ No newline at end of file diff --git a/docs/cli/built-in-commands/fields-list.md b/docs/cli/built-in-commands/fields-list.md index 9ed4051e1..f3b855772 100644 --- a/docs/cli/built-in-commands/fields-list.md +++ b/docs/cli/built-in-commands/fields-list.md @@ -94,9 +94,4 @@ You can combine multiple filters to narrow down your results: `php eecli.php fields:list --site=1 --type=text --format=json` -`php eecli.php fields:list -s 1 -t select -g blog_fields -f table` - ---- - -ExpressionEngine 7 Docs -©2002–2025 Packet Tide,LLC. Edit this page +`php eecli.php fields:list -s 1 -t select -g blog_fields -f table` \ No newline at end of file diff --git a/docs/cli/built-in-commands/fieldtypes-list.md b/docs/cli/built-in-commands/fieldtypes-list.md index 9ad8422d9..c5457f77d 100644 --- a/docs/cli/built-in-commands/fieldtypes-list.md +++ b/docs/cli/built-in-commands/fieldtypes-list.md @@ -75,8 +75,3 @@ You can combine multiple filters to narrow down your results: `php eecli.php fieldtypes:list --installed --addon=pro_search --format=json` `php eecli.php fieldtypes:list -i -s text,textarea -f table` - ---- - -ExpressionEngine 7 Docs -©2002–2025 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/version.md b/docs/cli/built-in-commands/version.md index 94e07990b..d9196fe0a 100644 --- a/docs/cli/built-in-commands/version.md +++ b/docs/cli/built-in-commands/version.md @@ -43,8 +43,3 @@ The following commands will show ExpressionEngine version information in simple `php eecli.php version -e build` `php eecli.php version --field=php_version` - ---- - -ExpressionEngine 7 Docs -©2002–2025 Packet Tide,LLC. Edit this page