ExpressionEngine Channel Structure API

Calling the Class

The Channel Structure class is called with the api->instantiate() function:

ee()->load->library('api'); ee()->legacy_api->instantiate('channel_structure');

Function Reference

class Api_channel_structure

get_channel_info($channel_id)

Fetches all metadata for a channel.

ee()->api_channel_structure->get_channel_info((int) $channel_id);

get_channels([$site_id = FALSE])

Fetches channel names and ids.

ee()->api_channel_structure->get_channels([(int) $site_id]);

delete_channel($channel_id = ''[, $site_id = NULL])

Delete a channel.

ee()->api_channel_structure->delete_channel((int) $channel_id, [(int) $site_id]);

create_channel($data)

Creates a new channel.

ee()->api_channel_structure->create_channel((array) $data);

At the minimum, channel_title and channel_name must be in the $data array.

Values that may be passed in the data array include:

• site_id, (int)
• channel_title, (string)
• channel_name, (string a-zA-Z0-9_- only)
• url_title_prefix, (string a-zA-Z0-9_- only)
• comment_expiration, (int)
• create_templates, (string yes/no) Also Requires:
  • old_group_id
  • group_name, (string a-zA-Z0-9_- only)
  • template_theme
• cat_group, (int or array of category group ids)
• dupe_id
• status_group
• field_group
• channel_url
• channel_lang
• group_order

Example Usage:

$data = array(
    'channel_title' => 'News',
    'channel_name'  => 'news',
    'field_group' => 2,
    'channel_url' => 'https://example.com/news/',
    'status_group'  => 1
);

if (ee()->api_channel_structure->create_channel($data) === FALSE)
{
    show_error('An Error Occurred Creating the Channel');
}

modify_channel($data)

Update an existing Channel:

ee()->api_channel_structure->modify_channel((array) $data);

The channel_id of the channel to be modified is required in the $data array. channel_title and channel_name are also required.

In addition to values in the exp_channels table, values that may be modified include:

• apply_expiration_to_existing, (bool) only if comment_expiration is set
• clear_versioning_data, (bool)

ExpressionEngine 6 Docs
©2002–2024 Packet Tide,LLC. Edit this page