Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified docs/_images/cp-members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/add-ons/pro-search/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ You can use the native `search:field_name` parameter to target specific fields.
### Parameters

#### `search:field_name`
Like the [channel search:field_name= parameter](/channel/channel_entries.html#search-field-name).
Like the [channel search:field_name= parameter](/channel/channel_entries.md#search-field-name).
#### `search:field_name:column_name`
Works just like the `search:field_name` parameter, but targets a specific column in a Grid/Matrix field.
#### `search:title`
Expand All @@ -178,7 +178,7 @@ You can use the native `search:field_name` parameter to target specific fields.
#### `search:status`
Works just like the `search:field_name` parameter, but targets statuses.
#### `contains_words`
Accepts parameter names. Force the given parameter values to match the full term, to ensure that the values are [not contained within other words](/channel/channel_entries.html#contains-matching). Also possible by using `search:field_name="value\W"`.
Accepts parameter names. Force the given parameter values to match the full term, to ensure that the values are [not contained within other words](/channel/channel_entries.md#contains-matching). Also possible by using `search:field_name="value\W"`.
#### `ends_with`
Accepts parameter names. Force the given parameter values to match the end of the target field. Also possible by using `search:field_name="value$"`.
#### `exact`
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-usage/front-end/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This special conditional allows you to display content if front-end editing is e
## Enable/Disable The Front Edit Link

There are several ways to disable front-end editing links:
- Globally with [configuration overrides](/general/system-configuration-overrides.html#enable_frontedit_links) or in [General Settings](/control-panel/settings/front-end-editing.md#enable-automatic-front-end-editing-links)
- Globally with [configuration overrides](/general/system-configuration-overrides.md#enable_frontedit_links) or in [General Settings](/control-panel/settings/front-end-editing.md#enable-automatic-front-end-editing-links)
- Per field in the [field settings](control-panel/field-manager/field-manager-settings.md)
- Via the Dock on the front-end by toggling Edit Mode on/off.
- In the template by using [ExpressionEngine template comments](#expressionengine-comment), [HTML comments](#html-comment), or [field parameter](#field-tag-parameter)
Expand Down
50 changes: 40 additions & 10 deletions docs/control-panel/member-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,25 @@

# Member Manager

**Control Panel Location: `Members`**
[TOC=2-3]

This page is used both to search and to browse through active members within your ExpressionEngine installation. Also, you can filter the members by member role and search members.
## Members Listing

This page also allows you to do the following:
**Control Panel Location: `Members`**

[TOC=2-3]
This page is used both to search and to browse through members within your ExpressionEngine installation.

![Member Manager Control Panel Page](_images/cp-members.png)

Filters and search input can be used to narrow down the list of members displayed.

The set of columns displayed can be customized using the "Columns" dropdown. By default, the following columns are shown: Member ID, Name (which is composed of avatar, username and screen name), Email, Roles, Join Date, Last Visit Date. Also each member row has "Actions" buttons that contains links to some common actions and a checkbox that allows performing bulk actions on selected members. When "Pending" is selected in the "Role" filter, the bulk action options are "Approve" and "Decline", otherwise "Remove" is the only option.

All roles assigned to a member are shown in the Roles column. When multiple roles are assigned, the primary role will have an indicator. If the member is pending the column does not say "Pending" but instead shows the role to which the member will be assigned once approved (with pending indicator) and a button to approve.

## Member Roles

**Control Panel Location: `Members > Member Roles`**
**Control Panel Location: `Members > Roles`**

The _Member Roles_ area of the Control Panel permits you to manage your Member Roles. The member roles can be sorted by ID, Role Name, and Status.

Expand All @@ -31,7 +37,7 @@ You can assign multiple roles to a member.

### Create/Edit All Member Roles

**Control Panel Location: `Members > Member Roles > Create/Edit`**
**Control Panel Location: `Members > Roles > Create/Edit`**

This sections allows you to set the various permissions and settings for the selected Member Role.

Expand All @@ -50,17 +56,41 @@ Edit the role by clicking its name in the list.

## Custom Member Fields

**Control Panel Location: `Members > Member Fields`**
**Control Panel Location: `Settings > Members > Member Fields`**

The link to this section is also found on top of the Member Listing page.

The _Member Fields_ feature permits you to add fields to the member registration form and/or member profile and My Account areas.

### Create/Edit

**Control Panel Location: `Members > Member Fields > New/Edit`**
**Control Panel Location: `Settings > Members > Member Fields > New/Edit`**

This section allows you to create or edit Member Fields.

The following fields are available:
The following field types are compatible and can be used for custom member fields:

- Checkboxes
- Color Picker
- Date
- Duration
- Email Address
- File
- Number Input
- Multi Select
- Radio Buttons
- Range Slider
- Rich Text Editor
- Select Dropdown
- Selectable Buttons
- Text Input
- Textarea
- URL
- Value Slider

Additionally, third-party field types that specify support for the `MemberField` model can be selected.

The following fields are available when creating a custom field:

- **Type** -- You may choose what type of field this is. There are three choices: 1. **Text Input**: This is a single input line for text. It is the type of field you might use for a title, name, or other short information. 2. **Textarea**: This is a standard text entry box with multiple lines. This is what you would use for larger amount of text. 3. **Drop-down List**: This creates a standard HTML `<select>` drop-down list. You will need to define contents of the list in the provided form.

Expand Down Expand Up @@ -90,7 +120,7 @@ This section has the following options:

## Ban Settings

**Control Panel Location: `Members sidebar > Ban Settings`**
**Control Panel Location: `Settings > Members > Ban Settings`**

The User Banning section of the Control Panel allows you to ban users by IP address, email, or name.

Expand Down
2 changes: 1 addition & 1 deletion docs/development/add-on-update-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The first thing you will notice in our `Amazing_add_on_upd` class is a list of p
```

## Install Your Add-On (`install()`)
The CLI automatically generates our install method. This method will ensure that all extensions and actions declared above will be properly installed. If you only need to install actions and/or extensions, then you can leave this method as is. Otherwise, use this section to add tabs to saved [publish layouts](), update the database, or do something else when the add-on is installed.
The CLI automatically generates our install method. This method will ensure that all extensions and actions declared above will be properly installed. If you only need to install actions and/or extensions, then you can leave this method as is. Otherwise, use this section to add tabs to saved [publish layouts](control-panel/channels.md#publish-layouts), update the database, or do something else when the add-on is installed.


| Parameter | Type | Description |
Expand Down
35 changes: 24 additions & 11 deletions docs/development/addon-setup-php-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,22 +102,35 @@ This indicates whether or not the add-on provides a plugin that should be made a
'fieldtypes' => array(
'hello_world' => array(
'name' => 'Hello World',
'compatibility' => 'text'
'compatibility' => 'text',
'use' => array(
'MemberField'
)
)
)

This is an associative array of the fieldtypes the add-on contains where the key corresponds to the fieldtype, `ft.hello_world.php` in the above example. Each fieldtype defines its name, which is used when creating or editing Channel Fields.

As of 3.1.0 fieldtypes can specify their compatibility. When editing a Channel Field the fieldtype options will be restricted to those fieldtypes that have the same compatibility. ExpressionEngine's native fieldtypes have the following compatibilities:
Fieldtypes can specify their compatibility. When editing a Channel Field the fieldtype options will be restricted to those fieldtypes that have the same compatibility. ExpressionEngine's native fieldtypes have the following compatibilities:

| Compatibility | Fieldtypes |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| date | [Date](fieldtypes/date.md) |
| file | [File](fieldtypes/file.md) |
| grid | [Grid](fieldtypes/grid.md) |
| list | [Checkboxes, Radio Buttons, Select, Multiselect](fieldtypes/select.md) |
| relationship | [Relationships](https://docs.expressionengine.com/latest/fieldtypes/relationships.html) |
| text | [Email Address](fieldtypes/email-address.md), [Rich Text Editor](fieldtypes/rte.md), [Text Input](fieldtypes/text.md), [Textarea](fieldtypes/textarea.md),[URL](fieldtypes/url.md) |
| Compatibility | Fieldtypes |
| ------------- | ----------------------------------------------------------------------------------- |
| date | [Date](fieldtypes/date.md) |
| file | [File](fieldtypes/file.md) |
| grid | [Grid](fieldtypes/grid.md) |
| list | [Checkboxes](fieldtypes/checkboxes.md), [Radio Buttons](fieldtypes/radio-buttons.md), [Select](fieldtypes/select.md), [Multiselect](fieldtypes/multiselect.md), [Selectable Buttons](fieldtypes/selectable-buttons.md) |
| relationship | [Relationships](fieldtypes/relationships.md) |
| text | [Color Picker](fieldtypes/colorpicker.md), [Duration](fieldtypes/duration.md), [Email Address](fieldtypes/email-address.md), [Number](fieldtypes/number.md), [Range Slider](fieldtypes/range-slider.md), [Rich Text Editor](fieldtypes/rte.md), [Text Input](fieldtypes/text.md), [Textarea](fieldtypes/textarea.md), [URL](fieldtypes/url.md), [Value Slider](fieldtypes/value-slider.md) |

If the fieldtype does not specify its compatibility then once a field is created with this fieldtype it cannot be changed.

All defined fieldtypes can be used in Channel Fields and ultimately Channel Entry content.

If a fieldtype is compatible with additional content types (such as the `MemberField` model that represents Custom Member Fields) then the model name needs to be specified in the `use` array.

'use' => array(
'MemberField'
)

### `modifiers`

Expand Down Expand Up @@ -255,4 +268,4 @@ It is also possible to set up class aliases to an arbitrary FQCN. The example be
If your add-on requires a particular version of ExpressionEngine, or a minimum version of PHP, adding `requires` to your addon.setup.php will check for minimum versions of the specified framework, and will stop installation if the minimum requirement is not meant.

## Accessing Add-On Information From Another Add-on
See the [Addon Service](development/services/addon.md) for API access.
See the [Addon Service](development/services/addon.md) for API access.
2 changes: 1 addition & 1 deletion docs/development/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Inside our class is the `process()` function. Again the CLI has already added al

TIP:Reference the [Available Core Hooks](development/extension-hooks/extension-hooks-overview.md) section of the docs to read on what parameters your hook uses.

From the [`typography_parse_type_end()`](/development/extension-hooks/global/typography.html#typography_parse_type_endstr-this-prefs) docs we can see that this hook modifies a string after all other typography is processed. Thus we should be able to take a string, manipulate it, then pass it back to ExpressionEngine to be rendered in the template.
From the [`typography_parse_type_end()`](/development/extension-hooks/global/typography.md#typography_parse_type_endstr-this-prefs) docs we can see that this hook modifies a string after all other typography is processed. Thus we should be able to take a string, manipulate it, then pass it back to ExpressionEngine to be rendered in the template.

We know that we should expect the following parameters for this hook:

Expand Down
2 changes: 1 addition & 1 deletion docs/development/legacy/libraries/cp.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,4 +187,4 @@ Modules have certain actions for forms, links, etc. that are recognized via an a

## Publish Page Layout Methods

Administrators may extensively customize publish pages on a per member role and per channel basis. Since these custom layouts are saved as a serialized array in the database, any additions or deletions to publish page tabs and fields must be synced to any saved layouts. The control panel library provides 4 methods to facilitate custom layout updates. (See also [Tab File Function Reference](development/modules.md#tab-file-function-reference)
Administrators may extensively customize publish pages on a per member role and per channel basis. Since these custom layouts are saved as a serialized array in the database, any additions or deletions to publish page tabs and fields must be synced to any saved layouts. The control panel library provides 4 methods to facilitate custom layout updates. (See also [Tab File Reference](development/tab-files.md)
2 changes: 1 addition & 1 deletion docs/development/v6-add-on-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ ExpressionEngine 6 supports displaying custom field data in the Entry Manager ta

### Base classes for add-on installation

While the legacy methods for installing modules and extensions are still supported, we’ve also made it easier by using the new [Add-on Installer](development/addon-installer.md).
While the legacy methods for installing modules and extensions are still supported, we’ve also made it easier by using the new [Add-on Installer](development/modernizing-existing-add-ons.md).


### Namespace change
Expand Down
Loading