Gets a list of instructors.
OPTIONS OPTIONS
- [--context=<context>]
- Scope under which the request is made; determines fields present in response.
---
default: view
options:
– view
– edit
--- - [--page=<page>]
- Current page of the collection.
---
default: 1
--- - [--per_page=<per_page>]
- Maximum number of items to be returned in result set.
---
default: 10
--- - [--search=<search>]
- Limit results to those matching a string.
- [--search_columns=<search_columns>]
- Column names to be searched. Accepts a single column or a comma separated list of columns.
---
default:
– id
– username
– email
– url
– name
--- - [--order=<order>]
- Order sort attribute ascending or descending.
---
default: asc
options:
– asc
– desc
--- - [--orderby=<orderby>]
- Sort collection by object attribute.
---
default: id
options:
– id
– email
– name
– registered_date
--- - [--include=<include>]
- Limit results to a list of ids. Accepts a single id or a comma separated list of ids.
- [--exclude=<exclude>]
- Exclude a list of ids from results. Accepts a single id or a comma separated list of ids.
- [--roles=<roles>]
- Include only users keys matching matching a specific role. Accepts a single role or a comma separated list of roles.
- [--post_in=<post_in>]
- Retrieve only instructors for the specified course(s) and/or membership(s). Accepts a single WP Post ID or a comma separated list of IDs.
- [--post_not_in=<post_not_in>]
- Exclude instructors who do not have permissions for the specified course(s) and/or membership(s). Accepts a single WP Post ID or a comma separated list of IDs.
- [--fields=<fields>]
- Limit response to specific fields. Defaults to all fields.
- [--field=<field>]
- Get the value of an individual field.
- [--format=<format>]
- Render response in a particular format.
---
default: table
options:
– table
– json
– csv
– ids
– yaml
– count
– headers
– body
– envelope
---
GLOBAL PARAMETERS GLOBAL PARAMETERS
These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
Argument | Description |
---|---|
--path=<path> |
Path to the WordPress files. |
--url=<url> |
Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] |
Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “vagrant”). |
--http=<http> |
Perform operation against a remote WordPress installation over HTTP. |
--user=<id\|login\|email> |
Set the WordPress user. |
--skip-plugins[=<plugins>] |
Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
--skip-themes[=<themes>] |
Skip loading all themes, or a comma-separated list of themes. |
--skip-packages |
Skip loading all installed packages. |
--require=<path> |
Load PHP file before running the command (may be used more than once). |
--exec=<php-code> |
Execute PHP code before running the command (may be used more than once). |
--[no-]color |
Whether to colorize the output. |
--debug[=<group>] |
Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
--prompt[=<assoc>] |
Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
--quiet |
Suppress informational messages. |