|
| 1 | +# `fields:list` |
| 2 | + |
| 3 | +Lists all channel fields in the system with their details in various formats. |
| 4 | + |
| 5 | +TIP: If you would like to create or manage channel fields programmatically, see the ChannelField Model documentation. |
| 6 | + |
| 7 | +## php eecli.php fields:list |
| 8 | + |
| 9 | +### Options list: |
| 10 | + |
| 11 | +``` |
| 12 | + --site=<value> |
| 13 | + -s <value> |
| 14 | + Site ID to list fields for |
| 15 | +
|
| 16 | + --format=<value> |
| 17 | + -f <value> |
| 18 | + Output format: table, json, or csv |
| 19 | +
|
| 20 | + --type=<value> |
| 21 | + -t <value> |
| 22 | + Filter by field type (e.g., text, textarea, select) |
| 23 | +
|
| 24 | + --group=<value> |
| 25 | + -g <value> |
| 26 | + Filter by field group name or short name |
| 27 | +
|
| 28 | + --channel_id=<value> |
| 29 | + -c <value> |
| 30 | + Filter by channel ID |
| 31 | +
|
| 32 | + --field_id=<value> |
| 33 | + -i <value> |
| 34 | + Filter by specific field ID |
| 35 | +``` |
| 36 | + |
| 37 | +## Examples: |
| 38 | + |
| 39 | +### Listing all fields: |
| 40 | + |
| 41 | +The following commands will list all channel fields in table format (default): |
| 42 | + |
| 43 | +`php eecli.php fields:list` |
| 44 | + |
| 45 | +`php eecli.php fields:list --format=table` |
| 46 | + |
| 47 | +`php eecli.php fields:list -f table` |
| 48 | + |
| 49 | +### Listing fields for a specific site: |
| 50 | + |
| 51 | +`php eecli.php fields:list --site=1` |
| 52 | + |
| 53 | +`php eecli.php fields:list -s 1` |
| 54 | + |
| 55 | +### Filtering by field type: |
| 56 | + |
| 57 | +`php eecli.php fields:list --type=text` |
| 58 | + |
| 59 | +`php eecli.php fields:list -t textarea` |
| 60 | + |
| 61 | +### Filtering by field group: |
| 62 | + |
| 63 | +`php eecli.php fields:list --group="Blog Fields"` |
| 64 | + |
| 65 | +`php eecli.php fields:list -g blog_fields` |
| 66 | + |
| 67 | +### Filtering by channel ID: |
| 68 | + |
| 69 | +`php eecli.php fields:list --channel_id=5` |
| 70 | + |
| 71 | +`php eecli.php fields:list -c 5` |
| 72 | + |
| 73 | +### Filtering by field ID: |
| 74 | + |
| 75 | +`php eecli.php fields:list --field_id=10` |
| 76 | + |
| 77 | +`php eecli.php fields:list -i 10` |
| 78 | + |
| 79 | +### Output in JSON format: |
| 80 | + |
| 81 | +`php eecli.php fields:list --format=json` |
| 82 | + |
| 83 | +`php eecli.php fields:list -f json` |
| 84 | + |
| 85 | +### Output in CSV format: |
| 86 | + |
| 87 | +`php eecli.php fields:list --format=csv` |
| 88 | + |
| 89 | +`php eecli.php fields:list -f csv` |
| 90 | + |
| 91 | +### Combining filters: |
| 92 | + |
| 93 | +You can combine multiple filters to narrow down your results: |
| 94 | + |
| 95 | +`php eecli.php fields:list --site=1 --type=text --format=json` |
| 96 | + |
| 97 | +`php eecli.php fields:list -s 1 -t select -g blog_fields -f table` |
0 commit comments