ExpressionEngine

https://github.com/expressionengine/expressionengine-user-guide
Admin
The source for the HTML ExpressionEngine user guides found at https://docs.expressionengine.com
Tokens:757,354
Snippets:8,363
Trust Score:9.4
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### MSM example config.php using site-specific environment variables

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/advanced-usage/env-support.md

Example system/user/config.php for MSM installations using $GLOBALS['assign_to_config']['site_name'] to access site-specific environment variables. Pairs with the MSM .env.php example.

```php
// system/user/config.php
<?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');

$config['save_tmpl_files'] = 'y';

$config['base_path'] = $_ENV[$GLOBALS['assign_to_config']['site_name'] . '.' . 'BASE_PATH'];
$config['base_url'] = $_ENV[$GLOBALS['assign_to_config']['site_name'] . '.' . 'BASE_URL'];

$config['site_url'] = $config['base_url'];

$config['app_version'] = '7.5.8';
$config['encryption_key'] = 'bb748b72de235352315122d00';
$config['session_crypt_key'] = '985796e4444444563463e2c80242';

$config['database'] = array(
	'expressionengine' => array(
		'hostname' => $_ENV['DB_HOSTNAME'],
		'database' => $_ENV['DB_DATABASE'],
		'username' => $_ENV['DB_USERNAME'],
		'password' => $_ENV['DB_PASSWORD'],
		'dbprefix' => 'exp_',
		'char_set' => 'utf8mb4',
		'dbcollat' => 'utf8mb4_unicode_ci',
		'port'     => $_ENV['DB_PORT'],
	),
);
$config['show_ee_news'] = 'y';

// EOF
```

--------------------------------

### Retrieve add-on data with ee('Addon')->get()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/addon.md

Use this snippet to get an Addon object for a specific add-on by its short name, then retrieve a value from its setup file using the get() method. The example outputs the add-on's description.

```php
$info = ee('Addon')->get('hello_world');
echo $info->get('description');
```

--------------------------------

### HTML widget example with {widget} tag

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/widgets.md

Example HTML widget. It must start with the {widget} tag, which supports class, title, and width parameters. The rest of the file is HTML that will be displayed inside the widget. HTML widgets are installed when the add-on is installed or updated.

```html
{widget class="widget--support" title="ExpressionEngine Support" width="half"}

<p>Get <b>direct</b>, <b>fast</b>, <b>unlimited</b> support from the same team that builds your favorite CMS.</p>

<p><a href="https://expressionengine.com/support" target="_blank" class="button button--default">Learn More</a></p>
```

--------------------------------

### MSM example .env.php with site-specific settings

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/advanced-usage/env-support.md

Example .env.php for MSM installations with site-specific settings using site short name as prefix. Assumes two MSM sites with short names default_site and second_site.

```plaintext
#.env.php
#SITE-SPECIFIC SETTINGS
default_site.BASE_PATH=/home/sites/mysite.test/
default_site.BASE_URL=http://mysite.test/

second_site.BASE_PATH=/home/sites/anothersite.test/
second_site.BASE_URL=http://anothersite.test/

#DATABASE SETTINGS
DB_HOSTNAME=db
DB_DATABASE=db
DB_USERNAME=db
DB_PASSWORD=db
DB_PORT=3306
```

--------------------------------

### Install dependencies with npm install

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/README.md

Installs all dependencies required to build the ExpressionEngine user guide. Requires Node and npm (latest stable version).

```bash
npm install
```

--------------------------------

### Example config.php using environment variables

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/advanced-usage/env-support.md

Example system/user/config.php file that uses environment variables for base URL and database settings. This pairs with the .env.php example above.

```php
// system/user/config.php
<?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');

$config['save_tmpl_files'] = 'y';

$config['base_url'] = $_ENV['BASE_URL'];
$config['site_url'] = $config['base_url'];

$config['app_version'] = '7.5.8';
$config['encryption_key'] = 'bb748b72de235352315122d00';
$config['session_crypt_key'] = '985796e4444444563463e2c80242';

$config['database'] = array(
	'expressionengine' => array(
		'hostname' => $_ENV['DB_HOSTNAME'],
		'database' => $_ENV['DB_DATABASE'],
		'username' => $_ENV['DB_USERNAME'],
		'password' => $_ENV['DB_PASSWORD'],
		'dbprefix' => 'exp_',
		'char_set' => 'utf8mb4',
		'dbcollat' => 'utf8mb4_unicode_ci',
		'port'     => $_ENV['DB_PORT'],
	),
);
$config['show_ee_news'] = 'y';

// EOF
```

--------------------------------

### addons:install - Install with dialog or --addon option

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/addons.md

Installs an add-on. The add-on name can be selected (typed) in dialog or provided with the `--addon` or `-a` option.

```shell
php eecli.php addons:install
```

```shell
php eecli.php addons:install --addon block_and_allow
```

--------------------------------

### install() method with parent::install() and return true

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/add-on-update-file.md

The CLI-generated install method ensures all extensions and actions are installed. Leave as is if only actions/extensions are needed; otherwise add database updates, publish tabs, etc. Returns TRUE on success, FALSE on failure.

```php
public function install()
{
    parent::install();

    // create a database table
    // notify mission control
    // add publish tabs

    return true;
}
```

--------------------------------

### Example: {layout="site/wrapper"}

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/layouts.md

Example using the wrapper template in the site template group as the layout for the current template.

```html
{layout="site/wrapper"}
```

--------------------------------

### setExample($example)

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/cp-form/field-sets.md

Sets the Example element for the Field Set.

```APIDOC
## setExample($example)

### Description
The Continued Description element to use for your Field Set (`example`).

### Method
setExample($example)

### Parameters
- **$example** (string) - Required - The value to use

### Returns
- **Form\Set** - `$this`, the Field Set object to help in chaining
```

--------------------------------

### Amazing Add-on directory structure

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/addon-development-overview.md

Shows the complete directory structure of an example add-on called "Amazing Add-on". It includes all possible folders and files, such as Commands, Extensions, ControlPanel, Actions, Tags, Model, language, widgets, views, and the required setup, extension, fieldtype, module, tab, and update files. Filenames use underscores instead of spaces and remove hyphens and special characters.

```text
amazing_add_on
 ┣ Commands
 ┃ ┗ CommandAnAmazingCommand.php
 ┣ database
 ┃ ┣ migrations
 ┃ ┃ ┗ 2022_11_14_170449_amazing_migration.php
 ┣ Extensions
 ┃ ┣ TemplatePostParse.php
 ┃ ┗ TypographyParseTypeEnd.php
 ┣ ControlPanel
 ┃ ┣ Routes
 ┃ ┃ ┣ Index.php
 ┃ ┃ ┗ Page2.php
 ┃ ┣ Sidebar.php
 ┣ Actions
 ┃ ┗ ExampleAction.php
 ┣ Tags
 ┃ ┗ ExampleTag.php
 ┣ Model
 ┃ ┗ AmazingModel.php
 ┣ language
 ┃ ┣ english
 ┃ ┃ ┣ amazing_add_on_lang.php
 ┃ ┃ ┗ index.html
 ┃ ┗ index.html
 ┣ widgets
 ┃ ┗ AnAmazingWidget.php
 ┣ views
 ┃ ┣ Index.php
 ┃ ┗ Page2.php
 ┣ addon.setup.php
 ┣ ext.amazing_add_on.php
 ┣ ft.amazing_add_on.php
 ┣ icon.svg
 ┣ mcp.amazing_add_on.php
 ┣ tab.amazing_add_on.php
 ┣ mod.amazing_add_on.php
 ┣ pro.amazing_add_on.php
 ┗ upd.amazing_add_on.php
 
```

--------------------------------

### require_all parameter example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/pro-search/tags.md

Parameter example for require_all, which treats the specified parameters as an inclusive stack.

```html
require_all="keywords"
```

--------------------------------

### year= parameter example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/channels/entries.md

Example showing how to display all entries from a specific year, here 2002.

```expressionengine
year="2002"
```

--------------------------------

### shortcut parameter example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/pro-search/tags.md

Parameter example for shortcut, which specifies the name of the shortcut to use for the search query.

```html
shortcut="shortcut_name"
```

--------------------------------

### orderby Parameter Examples

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/comment/entries.md

Examples of the orderby parameter with various sorting options.

```expressionengine
orderby="date"
```

```expressionengine
orderby="email"
```

```expressionengine
orderby="location"
```

```expressionengine
orderby="name"
```

```expressionengine
orderby="url"
```

```expressionengine
orderby="random"
```

--------------------------------

### Example path variable with channel/comments

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/globals/path.md

Example path variable that will be rendered as a URL including the site URL.

```expressionengine
{path='channel/comments'}
```

--------------------------------

### Full addon.setup.php example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/addon-setup-php-file.md

Complete example of an addon.setup.php file returning an associative array with required keys: author, author_url, name, description, version, and namespace.

```php
<?php

return array(
  'author'      => 'Example, Inc',
  'author_url'  => 'https://example.com',
  'name'        => 'Hello World',
  'description' => 'Displays a friendly "Hello world!" message.',
  'version'     => '2.0.0',
  'namespace'   => 'Example\HelloWorld'
);
```

--------------------------------

### Example Module URL with Argument

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/v3-add-on-migration.md

Example URL that passes an argument (3) to the edit_cookie method.

```text
addons/settings/fortune_cookie/edit_cookie/3
```

--------------------------------

### Markdown table example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/style-guide.md

Markdown table example showing preferences with defaults and options.

```markdown
| Preference   | Default | Options                       |
| ------------ | ------- | ----------------------------- |
| `local_time` | time()  | None                          |
| `start_day`  | sunday  | sunday, monday, tuesday, etc. |
```

--------------------------------

### Manual command registration in addon.setup.php

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/creating-a-command.md

Manual registration example for adding command classes in addon.setup.php under the 'commands' key using ::class values.

```php
'commands' => [
    'my_example_addon:sync-orders' => Vendor\MyExampleAddon\Commands\CommandSyncOrders::class,
],
```

--------------------------------

### force_shortcut parameter example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/pro-search/tags.md

Parameter example for force_shortcut, which controls whether a query overwrites a valid shortcut.

```html
force_shortcut="yes"
```

--------------------------------

### Template widget example: pro-dashboard-widgets template

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/widgets.md

Example template widget created as a template in the 'pro-dashboard-widgets' template group. It must follow the HTML widget syntax, starting with the {widget} tag. Unlike add-on widgets, template widgets are installed when the dashboard layout is updated.

```html
{widget title="Recent Entries" width="half"}
{exp:channel:entries channel="news" limit="10"}
    <h2>{title}</h2>
    {body}
{/exp:channel:entries}
```

--------------------------------

### Activating an action: migrate and --install

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/actions.md

Run the first command to activate the action by running all pending migrations; it will ask for the add-on name. The second command creates an action and immediately registers it in the database using the --install (or -i) flag.

```bash
$ php system/ee/eecli.php migrate
```

```bash
$ php system/ee/eecli.php make:action --install
```

--------------------------------

### Implement myaccount_nav_setup hook

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/extension-hooks/cp/myaccount.md

Example implementation of the myaccount_nav_setup hook. It checks for previous calls using ee()->extensions->last_call, loads a language file, and returns a new navigation item merged with existing calls using array_merge_recursive.

```php
    // Check for previous calls to myaccount_nav_setup hook
    $additional_nav = (ee()->extensions->last_call) ?
        ee()->extensions->last_call :
        array();

    // Load in language file for navigation wording
    ee()->lang->loadfile('extension_name');

    // Return new navigation item merged with existing calls to hook
    // Using array_merge_recursive for a deep clone
    return array_merge_recursive(
        $additional_nav,
        array(
            'customize_cp' => array(
                lang('extension_myaccount_settings') => array(
                    'extension' => 'extension_name',
                    'method'    => 'extension_myaccount_settings'
                )
            )
        )
    );
```

--------------------------------

### WysiHat.Selection.set(start [, end])

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/control-panel-js/wysihat-api.md

Sets up a new selection to surround the text that range. Can accept a 2-tuple from get() or separate start and end offsets.

```APIDOC
## WysiHat.Selection.set(start [, end])

### Description
Sets up a new selection to surround the text that range. Can accept a 2-tuple from get() or separate start and end offsets.

### Method
set

### Parameters
- **start** (number or array) - Required - Either the start offset or a 2-tuple [start, end] from get().
- **end** (number) - Optional - The end offset, if start is a number.
```

--------------------------------

### Example .env.php with database and URL settings

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/advanced-usage/env-support.md

Example .env.php file managing database connection settings and base URL. Use # for comments; using // will make the file unreadable.

```plaintext
#.env.php
#URLs
BASE_URL=http://mysite.test/

#DATABASE SETTINGS
DB_HOSTNAME=db
DB_DATABASE=db
DB_USERNAME=db
DB_PASSWORD=db
DB_PORT=3306
```

--------------------------------

### Updated addon.setup.php with commands array

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/creating-a-command.md

Example of the updated addon.setup.php file after running make:command. Shows the commands array entry mapping the command signature to the generated class.

```php
return [
    // ...
    'namespace' => 'Vendor\MyExampleAddon',
    'commands' => [
        'my_example_addon:sync-orders' => Vendor\MyExampleAddon\Commands\CommandSyncOrders::class,
    ],
];
```

--------------------------------

### getExample()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/cp-form/field-sets.md

Returns the Field Set Example.

```APIDOC
## getExample()

### Description
Returns the Field Set Example (`example`).

### Method
getExample()

### Parameters
None

### Returns
- **null** or **string** - The value to use
```

--------------------------------

### pro_search_params->get_prefixed

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/pro-search/development/functions.md

Gets all parameters where the name starts with given string.

```APIDOC
## pro_search_params->get_prefixed

### Description
Gets all parameters where the name starts with given string.

### Method
get_prefixed

### Parameters

#### Arguments
- **$prefix** (string) - Required - Prefix to look for.
- **$strip** (bool) - Required - Whether to strip the prefix from the parameter name when returning the matching parameters.

### Returns
An associative array of the matching parameters.
```

--------------------------------

### addons:install

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/addons.md

Installs an add-on. The add-on name can be selected interactively or provided via the --addon option.

```APIDOC
## addons:install

### Description
Installs an add-on. The add-on name can be selected (typed) in a dialog or provided with the `--addon` or `-a` option.

### Usage
```
php eecli.php addons:install [options]
```

### Options
- **--addon, -a** (string) - Optional - The name of the add-on to install. If not provided, a dialog will prompt for the add-on name.

### Examples
Run interactively:
```
php eecli.php addons:install
```

Install a specific add-on:
```
php eecli.php addons:install --addon block_and_allow
```
```

--------------------------------

### require_shortcut parameter example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/pro-search/tags.md

Parameter example for require_shortcut, which controls whether No Results is triggered when no valid shortcut is given.

```html
require_shortcut="no"
```

--------------------------------

### One-line make:addon example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/make-addon.md

One-line command to create an add-on with all options specified as arguments.

```bash
php ../../system/ee/eecli.php make:addon "My Example Addon" -v 0.1.0 -d "Some good description" -a "ExpressionEngine" -u https://expressionengine.com
```

--------------------------------

### WysiHat.Selection.get()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/control-panel-js/wysihat-api.md

Gets a selection. Returns an ordered pair of [start, end] text-based offsets.

```APIDOC
## WysiHat.Selection.get()

### Description
Gets a selection. Returns an ordered pair of [start, end] text-based offsets.

### Method
get

### Parameters
None

### Returns
- An array [start, end] representing text-based offsets.
```

--------------------------------

### Example output with <br /> tags

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/search/results.md

Example output showing the <br /> tag after each result field.

```html
Entry 1<br />
Entry 2<br />
Entry 3<br />
```

--------------------------------

### Basic model query with get()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/model/fetching.md

Starts a query for a model by name, returning a builder object for further narrowing.

```php
$builder = ee('Model')->get('Template');
```

--------------------------------

### Prepare upgrade and run ExpressionEngine upgrade

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/update-prepare.md

Runs update:prepare with the --upgrade-ee flag to start the ExpressionEngine upgrade after moving files.

```bash
php eecli.php update:prepare --upgrade-ee
```

--------------------------------

### Get content length with :length

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/variable-modifiers.md

Outputs the length of the content in characters. The example shows the modifier and its output (217).

```text
{excerpt:length}
{!-- 217 --}
```

--------------------------------

### CLI: Generate Templates for Member Management

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/generators.md

Generates a series of templates to help you get started building a custom member experience.

```APIDOC
## CLI: Generate Templates for Member Management

### Description
Generates a series of templates to help you get started building a custom member experience.

### Method
CLI

### Endpoint
`php system/ee/eecli.php generate:templates member:profile`

### Parameters
#### Path Parameters
- `member:profile` (string) - Required - The name of the template generator to run.

#### Options
- `--template_group` (string) - Required - The name of the template group which will contain the new templates.
- `--template_engine` (string) - Optional - The template engine to use (e.g., `twig`). Default is native.
- `--site_id` (integer) - Optional - The Site ID for MSM installations.
- `--templates` (string) - Optional - Specify "all" (default) or a comma-separated list of template names.
- `--show` (flag) - Optional - Display template content without creating templates.

### Request Example
```bash
php system/ee/eecli.php generate:templates member:profile --template_group=members
```

### Response
#### Success Response
- Creates the specified templates in the given template group.

#### Response Example
```
Templates generated successfully.
```
```

--------------------------------

### Get Channels Using a Channel Field

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/channel-field.md

Gets the channels that use a specific ChannelField via the Channels relationship. Note that this only finds channels where fields were assigned individually, not when included within a field group. The example shows both a multi-line and a one-line approach.

```php
// Get the field object.  #4 is the About Images field.
$field = ee('Model')->get('ChannelField', 4)->first();

// Get the Channel's object using the Channel relationship.
$channels = $field->Channels;

// Returns an array of channel IDs.
$channel_ids = $channels->pluck('channel_id');

// As one line:
 $channel_ids = ee('Model')->get('ChannelField', 4)->first()->Channels->pluck('channel_id');
```

--------------------------------

### Get a Channel Field by ID

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/channel-field.md

Retrieves a single ChannelField model by ID. Field #4 is the "About Images" field in the sample installation.

```php
ee('Model')->get('ChannelField', 4)->first();
```

--------------------------------

### update:prepare options list

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/update-prepare.md

Lists all available CLI options for the update:prepare command, including flags for upgrading, moving paths, and running hooks.

```text
    --upgrade-ee
        Start the upgrade after moving files

    --force-add-on-upgrade
        After upgrading EE, runs add-on upgrades

    --old-base-path=<value>
        Absolute path of old site

    --new-base-path=<value>
        Absolute path of new site

    --old-public-path=<value>
        Absolute path of old site public path

    --new-public-path=<value>
        Absolute path of new site public path

    --no-config-file
        Ignore upgrade.config.php and use interactive/CLI values

    --ee-version
        Current site version source flag used by the upgrade preparer

    --should-move-system-path
        Move old system folder to the new site

    --old-system-path=<value>
        Absolute path of old site system folder

    --new-system-path=<value>
        Absolute path of new site system folder

    --should-move-template-path
        Move old template folder to the new site

    --old-template-path=<value>
        Absolute path of old site template folder

    --new-template-path=<value>
        Absolute path of new site template folder

    --should-move-theme-path
        Move old theme folder to the new site

    --old-theme-path=<value>
        Absolute path of old site user theme folder

    --new-theme-path=<value>
        Absolute path of new site user theme folder

    --run-preflight-hooks
        Run preflight hooks defined in upgrade config

    --run-postflight-hooks
        Run postflight hooks defined in upgrade config

    --temp-directory
        Temporary working directory flag used by the upgrade preparer
```

--------------------------------

### Get a Role by ID

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/role.md

Fetches a single Role model by its primary key using the ExpressionEngine model service. The role_id is hard-coded to 6 in this example.

```php
$role_id = 6;
$role = ee('Model')->get('Role', $role_id)->first();
```

--------------------------------

### Create and render a view with ee('View')->make()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/view.md

Creates a view instance and renders it with an associative array of data. The view path is prefixed with the add-on folder name.

```php
$view = ee('View')->make('addon_name:member/profile');

$output = $view->render(array(
  'member' => $current_member
));
```

--------------------------------

### Count matching elements with count()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/model/fetching.md

Use the count() method to get the number of matching elements without retrieving all data. This example counts all Template models.

```php
$total_templates = ee('Model')->get('Template')->count();
```

--------------------------------

### Grid field count variable

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/fieldtypes/grid.md

Outputs the count of the current row being displayed, starting at 1. For example, the fourth row would output "4".

```markup
{grid_field:count}
```

--------------------------------

### Simple Example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/pagination.md

Basic usage of the CP/Pagination service to render pagination with a total count and a base URL.

```APIDOC
## Simple Example

### Description
Basic usage of the CP/Pagination service to render pagination with a total count and a base URL.

### Code
```php
$base_url = ee('CP/URL', 'publish/edit');
$pagination = ee('CP/Pagination', $total_count)
  ->render($base_url);
```
```

--------------------------------

### Variable Modifier for String Length

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/language.md

Use the :length modifier on a variable to get the length of its value. The example outputs the number of characters in the {excerpt} variable, shown as 217 in the comment.

```ExpressionEngine
{excerpt:length}
{!-- Outputs: 217 --}
```

--------------------------------

### Generate an add-on with make:addon

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/addon-development-overview.md

Run the CLI command to generate a new add-on. The command prompts for the add-on name, description, version, author, and author URL, then creates the add-on in the system/user/addons folder.

```bash
$ php system/ee/eecli.php make:addon
Let's build your add-on!
What is the name of your add-on? Amazing Add-On
Add-on description? [Amazing Add-on description] This add-on does amazing things!
Add-on version? [1.0.0]1.0.0
Add-on author? ExpressionEngine Developer
Add-on author URL? www.expressionengine.com
Let's build!
Your add-on has been created successfully!

```

--------------------------------

### Set encryption_key in config.php

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/config/config.md

Secret key for the Encrypt service to protect sensitive data. Set automatically during installation; generate a new one via the Troubleshooting guide if needed.

```php
$config['encryption_key'] = '26791dcd5c7cc9e569cc05b16b96235985cc9f03';
```

--------------------------------

### Get a File by ID

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/file.md

Retrieves a File model instance by its ID using the ExpressionEngine model API. The example fetches the file with ID 4 and returns the first matching record.

```php
$file = ee('Model')->get('File', 4)->first();
```

--------------------------------

### Pagination with limit() and offset()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/model/fetching.md

Pagination example using limit() and offset(). Accepts a page number and returns the correct template models for that page. The first page starts at offset 0.

```php
function getTemplatesForPage($n)
{
  $per_page = 10;

  $start = $per_page * ($n - 1); // this ensures page 1 starts at 0

  return ee('Model')
    ->get('Template')
    ->offset($start)
    ->limit($per_page)
    ->all();
}
```

--------------------------------

### Get help for config:config

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/usage.md

Displays help information for the config:config command, including usage, description, and options.

```bash
$ php system/ee/eecli.php config:config -h

SUMMARY
    Update Config Values -- Gives the ability to update config values

USAGE
    Update Config Values php eecli.php config:config -c is_system_on -v n

DESCRIPTION
    Updates config values in config.php file

OPTIONS
    --config-variable=<value>
    -c <value>
        The config item to modify

    --value=<value>
    -v <value>
        The value to set the config item to
```

--------------------------------

### Example member names output with <br> tags

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/statistics.md

Example output of member names separated by <br> tags, used to illustrate backspacing.

```html
Joe<br>
Fred<br>
Sallie<br>
```

--------------------------------

### Get directory contents with ee('Filesystem')->getDirectoryContents()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/filesystem.md

Retrieves the contents of a directory. The second parameter, when true, likely indicates recursive retrieval. This example shows the basic usage of the Filesystem service.

```php
$directory_list = ee('Filesystem')->getDirectoryContents($path, true);
```

--------------------------------

### Example URL with index.php

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/installation/best-practices.md

Shows a typical ExpressionEngine URL containing index.php before removal.

```markdown
https://example.com/index.php/template_group/template
```

--------------------------------

### Add a Field Set to a Field Group

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/cp-form/group.md

Once you have a Field Group, use getFieldSet() to retrieve or create a Field Set within it. The example shows getting a Field Set named 'First Name'.

```php
$field_set = $field_group->getFieldSet('First Name');
```

--------------------------------

### make:addon options

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/make-addon.md

Lists the command-line options for the make:addon command, including short and long flags for version, description, author, and author URL.

```text
    --version=<value>
    -v <value>
        Version of the add-on

    --description=<value>
    -d <value>
        Description of the add-on

    --author=<value>
    -a <value>
        Author of the add-on

    --author-url=<value>
    -u <value>
        Author url of the add-on
```

--------------------------------

### Number Normalization Examples

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/conditionals.md

Shows how numbers are normalized when used in comparisons: redundant leading and trailing zeros are removed, and floating point numbers less than 1 get a leading zero added if not present.

```text
.7 becomes 0.7
1. becomes 1
.20 becomes 0.2
0002 becomes 2
002.5000 becomes 2.5
```

--------------------------------

### Serve local docs with npx http-server -o

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/README.md

Serves the built documentation locally and opens it in the browser. The site should be available at http://127.0.0.1:8080/build/.

```bash
npx http-server -o
```

--------------------------------

### make:command options list

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/make-command.md

Lists the available options for the make:command generator: --addon/-a specifies the add-on folder, --description/-d provides a description, and --signature/-s sets the command signature.

```text
    --addon=<value>
    -a <value>
        Folder for third-party add-on you want to add command to

    --description=<value>
    -d <value>
        Description of command

    --signature=<value>
    -s <value>
        Signature for command (i.e. make:magic)
```

--------------------------------

### Get All Custom Member Fields

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/member-field.md

Retrieves all custom member fields as a dictionary keyed by field ID with field label values. The example return shows the format: [4 => 'My Field Name'].

```php
$all_member_fields = ee('Model')
        ->get('MemberField')
        ->fields('m_field_label','m_field_id')
        ->all()
        ->getDictionary('m_field_id', 'm_field_label');

// Example return: [4 => 'My Field Name']
```

--------------------------------

### depth= parameter example with depth 2

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/date-variable-formatting.md

Determines how many calculated units to display, starting from the largest non-zero unit. Default is "1". With depth 2, units are joined with "and".

```ExpressionEngine
{entry_date:relative depth="2"}
```

```HTML
4 days and 3 hours ago
```

--------------------------------

### Create an action with make:action

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/actions.md

Run the CLI command to create a new action. The CLI prompts for the action name and add-on name, then confirms success.

```bash
php system/ee/eecli.php make:action
What is the action name? ExampleAction
What add-on is the action being added to? amazing_add_on
Action created successfully!
```

--------------------------------

### Show version information in simple format

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/version.md

Commands to display version information in the default simple format.

```bash
php eecli.php version
```

```bash
php eecli.php version --format=simple
```

```bash
php eecli.php version -f simple
```

--------------------------------

### Fetch data from an entry's Fluid field

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/channel-entry.md

Retrieves all individual fields within a Fluid field for a given entry. Filters by entry ID and fluid field ID, orders by the 'order' column, and returns a collection. Use pluck('field_id') to get an array of field IDs, and fetchFieldData() to get an array of data from each field. The example return shows the structure of the fetched data.

```php
$field_objects = ee('Model')
                    ->get('fluid_field:FluidField')
                    ->filter('entry_id', $entry_id) // The Entry ID
                    ->filter('fluid_field_id', $fluid_field_id) // The fluid field in the entry.
                    ->order('order') // Important to maintain the field order within the fluid field.
                    ->all(); // Get all the individual fields within the fluid field.

// Get an array of field IDs
$field_objects->pluck('field_id'); // array(3, 45, 2, 5);

// Get an array of data from each field within a Fluid fieldtype:
$field_objects->fetchFieldData();

// Example Return:
array(
    array(
        'id'         => 2
        'entry_id'   => 4,
        'field_id_1' => 'your field data',
        'field_ft_1' => 'none',
    ),
    array(
        'id'          => 5
        'entry_id'    => 4,
        'field_id_5'  => 'your field data',
        'field_ft_5'  => 'xhtml',
    ),
)
```

--------------------------------

### Get CpLog entries by member ID

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/cp-log.md

Fetches all control panel access log entries for a given member ID using the ExpressionEngine model API. The example filters the CpLog model by 'member_id' and returns all matching records.

```php
$member_id = 1;

$super_admin_logs = ee('Model')->get('CpLog')->filter('member_id', $member_id)->all();
```

--------------------------------

### make:migration options list

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/make-migration.md

Lists all available options for the make:migration command, including short and long forms, descriptions, and defaults.

```text
    --name=<value>
    -n <value>
        Name of migration

    --table=<value>
    -t <value>
        Table name

    --status=<value>
    -s <value>
        Status name

    --location=<value>
    -l <value>
        Migration location. Current options are ExpressionEngine or shortname of an add-on that is currently installed. Defaults to ExpressionEngine.

    --create
    -c
        Specify command is a create command

    --update
    -u
        Specify command is an update command

```

--------------------------------

### Set up and run Cypress tests

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/cypress-tests.md

Commands to set up and run Cypress tests. Run from the tests/cypress directory. The last command runs a specific test file; use a wildcard to run all tests in a folder.

```bash
cd tests/cypress
```

```bash
npm i
```

```bash
cp cypress.env.example.json cypress.env.json
```

```bash
npm run cypress:open
```

```bash
npx cypress run --headed --no-exit -s cypress/integration/cp/login.ee6.js
```

--------------------------------

### Get Memory Limit in Bytes with ee('Memory')->getMemoryLimitBytes()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/memory.md

Retrieves the current PHP memory limit in bytes, standardizing the ini value which may be in various formats. The example shows a typical result of 536870912 bytes (512 MB).

```php
$current_limit = ee('Memory')->getMemoryLimitBytes();
// e.g. 536870912
```

--------------------------------

### Prepare upgrade interactively

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/update-prepare.md

Runs update:prepare without any flags, prompting for configuration values interactively.

```bash
php eecli.php update:prepare
```

--------------------------------

### Get an Action ID by Method

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/models/action.md

Retrieves the action ID for a given method using the Action model and constructs the corresponding action URL. The example filters by 'your_addon_method' and uses the first matching record. The resulting URL is built with the site index and the 'ACT' query parameter.

```php
$action_id = ee('Model')
                ->get('Action')
                ->filter('method', 'your_addon_method')
                ->first()
                ->action_id;
                
// Create a URL to that action.
$action_url = ee()->functions->fetch_site_index(0, 0) . QUERY_MARKER . 'ACT=' . $action_id;
```

--------------------------------

### Simple Pagination Example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/pagination.md

Uses the CP/Pagination service to render pagination for a list of items. Requires the total count and a CP URL object; the service handles calculations.

```php
$base_url = ee('CP/URL', 'publish/edit');
$pagination = ee('CP/Pagination', $total_count)
  ->render($base_url);
```

--------------------------------

### Filesystem Cypress tasks (delete, create, createFile, copy, path, list, read, rename)

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/cypress-tests.md

Examples of filesystem-related Cypress tasks: deleting files, creating directories and files, copying files, getting server paths, listing files by mask, reading files, and renaming files or directories.

```javascript
cy.task('filesystem:delete', '../../images/about/')
```

```javascript
cy.task('filesystem:create', Cypress.env("TEMP_DIR")+'/about')
```

```javascript
cy.task('filesystem:createFile', Cypress.env("TEMP_DIR")+'/test.html')
```

```javascript
cy.task('filesystem:copy', { from: Cypress.env("TEMP_DIR")+'/about/*', to: '../../images/about' })
```

```javascript
cy.task('filesystem:path', 'support/tmp')
```

```javascript
cy.task('filesystem:list', {target: upload_path, mask: '/*.png'})
```

```javascript
cy.task('filesystem:read', '../../system/user/config/config.php')
```

```javascript
cy.task('filesystem:rename', {from: installer_folder, to: '../../system/ee/installer'})
```

--------------------------------

### Initialize a Prolet with ee('pro:Prolet')->initialize()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/prolets.md

Initializes the prolet from a template tag. The call to ee('pro:Prolet')->initialize() must be wrapped in a conditional checking IS_PRO so it only runs on ExpressionEngine versions with Pro installed. The first parameter is the prolet name and the second is an array of data passed via GET request.

```php
if (defined('IS_PRO') && IS_PRO) {
    ee('pro:Prolet')->initialize('sample_prolet', ['entry_id' => $entry_id]);
}
```

--------------------------------

### Interactive make:addon example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/make-addon.md

Shows the interactive prompt flow when running make:addon without arguments, including the expected prompts and successful creation message.

```bash
    $ php system/ee/eecli.php make:addon
    Let's build your add-on!
    What is the name of your add-on? Amazing Add-On
    Add-on description? [Amazing Add-on description] This add-on does amazing things!
    Add-on version? [1.0.0]1.0.0
    Add-on author? ExpressionEngine Developer
    Add-on author URL? www.expressionengine.com
    Let's build!
    Your add-on has been created successfully!
```

--------------------------------

### List only installed fieldtypes

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/fieldtypes-list.md

These commands list only fieldtypes from installed add-ons using the `--installed` or `-i` flag.

```bash
php eecli.php fieldtypes:list --installed
```

```bash
php eecli.php fieldtypes:list -i
```

--------------------------------

### addons:list - List all add-ons

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/addons.md

Lists all add-ons available in the system.

```shell
php eecli.php addons:list
```

--------------------------------

### addons:list - List installed add-ons

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/addons.md

Lists add-ons that are currently installed, using either the `i` or `installed` argument.

```shell
php eecli.php addons:list i
```

```shell
php eecli.php addons:list installed
```

--------------------------------

### Build the docs with npm run build

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/README.md

Builds the documentation HTML files from the Markdown source.

```bash
npm run build
```

--------------------------------

### install() method with default global settings

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/fieldtypes/example.md

The install() method returns an array of default global settings for the fieldtype: latitude, longitude, and zoom. These values determine the default map appearance.

```php
function install()
{
    // Somewhere in Oregon ...
    return array(
        'latitude'  => '44.06193297865348',
        'longitude' => '-121.27584457397461',
        'zoom'      => 13
    );
}
```

--------------------------------

### Table Field Example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/services/cp-form/fields.md

Example usage of the Table field methods.

```APIDOC
```php
$table = $field_set->getField('my_table', 'table');

$table->setOptions([
    'lang_cols' => true,
    'class' => 'product_channels'
]);

$table->setColumns([
    'details' => ['sort' => false],
    'value' => ['sort' => false],
]);

$table->setNoResultsText(sprintf(lang('no_found'), lang('product_channels')));
$table->setBaseUrl( ee('CP/URL')->make($this->base_url ));
$data = [];
$data[] = [
    'Hello',
    'You',
];

$table->setData($data);
$table->addRow([
    'No, Hello',
    'To You!',
]);
```
```

--------------------------------

### member_ids Output Example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/fieldtypes/member.md

Example output of the :member_ids modifier, pipe-delimited.

```text
43|58|127
```

--------------------------------

### Create an extension hook with the CLI

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/extensions.md

Run this command to generate an extension hook. It prompts for the hook name and add-on name, then creates the extension file and folder. Use the --install or -i flag to enable the extension immediately.

```bash
$ php system/ee/eecli.php make:extension-hook -i
Let's implement an extension hook!
What hooks would you like to use? (Read more: https://docs.expressionengine.com/latest/development/extensions.html) typography_parse_type_end
What add-on is the extension hook being added to? [amazing_add_on]:  amazing_add_on
Building Extension hook.
Extension hook created successfully!

```

--------------------------------

### pro_search_params->get

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/pro-search/development/functions.md

Gets all parameters for this search query, or a single one.

```APIDOC
## pro_search_params->get

### Description
Gets all parameters for this search query, or a single one.

### Method
get

### Parameters

#### Arguments
- **$key** (string, optional) - Optional - Parameter name to get. Omit for all.
- **$fallback** (mixed, optional) - Optional - Value to return if parameter is not set.

### Returns
All parameters if no key is given, the parameter value if present, or the fallback if not present.
```

--------------------------------

### Embed Example: site/header

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/embedding.md

Example of embedding the 'header' template from the 'site' group.

```markup
{embed="site/header"}
```

--------------------------------

### Row start variable pair

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/channels/calendar.md

Defines the content to use at the start of a row.

```text
{row_start}<tr>{/row_start}
```

--------------------------------

### core_boot()

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/extension-hooks/global/core.md

Runs tasks on every ExpressionEngine request. This hook fires on all requests, so be mindful of performance. Use the REQ constant to check the request type (PAGE, CP, or ACTION).

```APIDOC
## core_boot()

### Description
Runs tasks on every ExpressionEngine request. This hook fires on all requests, so be mindful of performance. Use the REQ constant to check the request type (PAGE, CP, or ACTION).

### Method
Hook

### Parameters
None

### Returns
`Void`

### How it's called
```php
 ee()->extensions->call('core_boot');
 if (ee()->extensions->end_script === TRUE) return;
```

### Example Usage
```php
if (REQ != 'CP')
{
  // Do work only on control panel requests
  return;
}
```
```

--------------------------------

### Example return for publish_live_preview_route

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/extension-hooks/cp/publish.md

Shows the required return array structure for the publish_live_preview_route hook, including both 'uri' and 'template_id' keys.

```php
return [
    'uri'         => 'my/special/uri',
    'template_id' => 5
];
```

--------------------------------

### Options list for make:sidebar

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/make-sidebar.md

Lists the available options for the make:sidebar command, including the --addon option and its short form -a.

```text
    --addon=<value>
    -a <value>
        Folder for third-party add-on you want to add sidebar to
```

--------------------------------

### Template route example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/templates/globals/path.md

Example of a template route definition that the above route variable uses.

```text
/archive/{year}/{month}
```

--------------------------------

### member_ids with delimiter Output Example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/fieldtypes/member.md

Example output of the :member_ids modifier with a comma delimiter.

```text
43,48,127
```

--------------------------------

### Correct class and file naming examples with prefix

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/development/guidelines/general.md

Correct naming examples for classes and files that use a unique prefix (Pre_) to avoid collisions. This does not apply to namespaced classes.

```php
class Pre_email
pi.pre_email.php
class Pre_xml
ext.pre_xml.php
class Pre_import
mod.pre_import.php
```

--------------------------------

### Run sync:upload-directory with upload ID and manipulations

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/cli/built-in-commands/sync-upload-directory.md

Example command that synchronizes the file records in the database with the files stored in upload directory ID 6 and regenerates all image manipulations.

```bash
php eecli.php sync:upload-directory --upload-id=6 --manipulations=all
```

--------------------------------

### Example encryption_key and session_crypt_key in config.php

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/troubleshooting/error-messages.md

See the expected format of the two required config keys in system/user/config/config.php. These sample values are not to be used; generate your own.

```php
$config['encryption_key']    = '26791dcd5c7cc9e569cc05b16b96235985cc9f03';
$config['session_crypt_key'] = 'd9e776dc9a5de0cd83e7c76a76756daa64ff4b8b';
```

--------------------------------

### comment_id Parameter Example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/comment/entries.md

Example of the comment_id parameter to hard code specific comments.

```expressionengine
comment_id="22"
```

--------------------------------

### author_id Parameter Example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/comment/entries.md

Example of the author_id parameter to filter comments by author ID.

```expressionengine
author_id="5"
```

--------------------------------

### channel_set.json upload_destinations example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/channels/sets.md

Example of the upload_destinations array in channel_set.json, showing a name property.

```json
{
    "upload_destinations": [
        {
            "name": "Blog Images",
        }
    ]
}
```

--------------------------------

### query parameter example

Source: https://github.com/expressionengine/expressionengine-user-guide/blob/7.dev/docs/add-ons/pro-search/tags.md

Parameter example for query, which references an encoded search query.

```html
query="{segment_3}"
```
Tokens:
Raw