ExpressionEngine 2.0 Syntax Changes¶

In the move to 2.0, a number of classes have been renamed, deprecated, and/or split up among helper functions. Some methods have also been moved to new classes. EE 2.0 also replaces the use of global objects with the use of the super object, necessitating a different approach to initializing required classes. This section is an overview of syntax changes that will be required for third party integration with the new ExpressionEngine.

General Syntax Changes¶

Change class names for extensions¶

The PHP class in extensions must now include the suffix _ext. So if your Extension is named “Krakow”, then the extension file will be exp.krakow.php and the PHP class will be named Krakow_ext

Change class names for module control panels¶

The PHP class in extensions must now include the suffix _mcp instead of _CP. So if your Module is named “Krakow”, then the module control panel file will be mcp.krakow.php and the PHP class will be named Krakow_mcp

Switch from globals to the super object¶

Methods are no longer called from global object references. Instead, a local instance of the super object is used.

Remove all globals from your methods.
Get a reference to the super object in your class constructor.
Switch your syntax to use the super object.

class Some_class {      function __construct($params)     {         $this->EE =& get_instance();                  // now all calls to class methods go through $this->EE         $this->EE->functions->redirect();

Switch ‘weblog’ terminology to ‘channel’ terminology¶

Change the word “weblog” in parameters and database calls to “channel”. For consistency, we recommend that if your add-on has its own tables with columns containing the word “weblog” that you perform an ALTER in your update script to change it to “channel” as well.

Protect your scripts from direct access¶

Start every php file with a security check:

<?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');

Paths and Constants¶

The APPPATH constant is the path to system/expressionengine/ and should be used in place of any current constants such as PATH_CACHE, PATH_EXT, etc.

OLD syntax: $this->cache_path = PATH_CACHE.$this->cache_name.'/'.md5($this->username);

NEW syntax: $this->cache_path = APPPATH.'cache/'.$this->cache_name.'/'.md5($this->username);

Note

Files located using PATH_CP will be in a library or core class, and should use the appropriate method for each.

The QUERY_MARKER constant replaces the use of the configuration item ‘force_query_strings’.

OLD syntax:

$qs = ($PREFS->ini('force_query_string') == 'y') ? '' : '?';
$search_link = $FNS->fetch_site_index(0, 0).$qs.'ACT='

NEW syntax:

$search_link = $this->EE->functions->fetch_site_index(0, 0).QUERY_MARKER.'ACT='

The SLASH constant has been removed from the template parser, and forward slashes are no longer converted to entities. For example, the following str_replace() examples are no longer necessary to perform in a module or plugin’s tagdata:

OLD syntax:

        // neither $str = str_replace(SLASH, '/', $str);
        // nor $str = str_replace('&#47;', '/', $str);

The XID_SECURE_HASH constant is used primarily in javascript as the secure forms hash. If you are using the Form helper, it will automatically be added to control panel forms as needed.

var data = "keywords=" + escape(keywords) + "&groups=" + search_groups + "&XID={XID_SECURE_HASH}";

Renamed Objects¶

Some object names have been changed. Pre-2.0 code will need to be adjusted accordingly.

BM = benchmark

DB = db

EXT = extensions

FNS = functions

IN = input

LANG = lang

LOC = localize

OUT = output

PREFS = config

SESS = session

STAT = stats (note that it’s plural now)

Deprecated Objects¶

Some classes have been deprecated and the functions moved or replaced.

REGX

DSP

Libraries¶

A number of EE classes are now libraries, located in /system/expressionengine/libraries/. To use one of these classes, you invoke it using the following syntax:

$this->EE->load->library('class name');

Where class name is the name of the class you want to invoke. For example:

OLD syntax:

if ( ! class_exists('Typography'))
{
        require PATH_CORE.'core.typography'.EXT;
}

$TYPE = new Typography;
$str = $TYPE->light_xhtml_typography($str);

NEW syntax:

$this->EE->load->library('typography');
$this->EE->load->typography->initialize();
$str = $this->EE->typography->light_xhtml_typography($str);

Note that after loading the Typography library you need to initialize it with $this->EE->load->typography->initialize(); or you will be inheriting the class properties of whatever code last used it.

Helper Functions¶

Helpers are collections of simple procedural functions that fit within a given category. For example, there is a Text helper that is a collection of functions that perform various text formatting routines, a URI helper that is used for working with urls, and a form helper that’s used to quickly create proper forms. The helper files are located in /system/expressionengine/helpers/. To use one of their functions, you invoke it using the following syntax:

$this->EE->load->helper('helper_name');

Where helper_name is the name of the helper you want to invoke. For example, to limit a string to 10 words in length, you would use:

$this->EE->load->helper('text'); $str = word_limiter($str, 10);

The helpers most likely to be used in plugins and modules include:

Directory Helper
File Helper
Form helper
String helper
Text helper
URI helper (replaces a number of input class methods)

Refer to CodeIgniter’s user guide for details on all available helpers.

Renamed Functions by (Old) Class¶

Database Class¶

All queries should be rewritten to use active record
The exp_weblogs, exp_weblog_titles and exp_weblog_data tables have been changed to use ‘channel’ nomenclature instead of ‘weblog’
Queries should be compatible with MySQL running in “strict mode”. If you are inserting data into a table with an auto-incremented field and try to insert an empty string to that field, it will cause an error under MySQL in “strict mode”. More details can be found in the MySQL SQL Mode FAQ.

The architecture of the database driver has changed. See the CodeIgniter user guide for full details of the database class. Here is a short summary of some of the old vs. new syntax:

->num\_rows
    ->num\_rows()
->row['field\_name']
    ->row('field\_name')
->result as $row)
    ->result\_array() as $row) // $row is an array
(n/a)
    ->result() as $row) // $row is an object

Display Class¶

$DSP->allowed\_group('can\_admin\_channels')
    $this->EE->cp->allowed\_group('can\_admin\_channels')
$DSP->breadcrumb()
    $this->EE-cp->set\_breadcrumb()
$DSP->html\_header()
    $this->EE-cp->set\_variable('cp\_page\_title', $value)
$DSP->error\_message()
    show\_error()

Email Class¶

$email->initialize()
    $this->EE->email->EE\_initialize();

Extensions Class¶

$EXT->call\_extension
    $this->EE->extensions->call
$EXT->universal\_call\_extension
    $this->EE->extensions->universal\_call

Functions Class¶

$FNS->fetch\_action\_id()
    $this->EE->cp->fetch\_action\_id()
    Note: for use in the control panel
    $this->EE->functions->fetch\_action\_id()
    Note: for use in the module file
$FNS->filename\_security()
    $this->EE->security->sanitize\_filename

Input Class¶

$IN->URI
    $this->EE->uri->uri\_string
$IN->QSTR
    $this->EE->uri->query\_string
$IN->Pages\_QSTR
    $this->EE->uri->page\_query\_string
$IN->IP
    $this->EE->input->ip\_address()
$IN->blacklisted
    $this->EE->blacklist->blacklisted
$IN->whitelisted
    $this->EE->blacklist->whitelisted
$IN->SEGS
    $this->EE->uri->segments
$IN->parse\_uri
    Private method (Input class)
$IN->fetch\_uri\_segment()
    $this->EE->uri->segment()
$IN->clean\_input\_data
    Private method (Input class)

$IN->GBL('name', 'GP')
    $this->EE->input->get\_post('name')
$IN->GBL('name')
    $this->EE->input->get\_post('name')
$IN->GBL('name', 'POST')
    $this->EE->input->post('name')
$IN->GBL('name', 'GET')
    $this->EE->input->get('name')
$IN->GBL('name', 'COOKIE')
    $this->EE->input->cookie('name')

Language Class¶

$LANG->fetch\_language\_file
    $this->EE->lang->loadfile

Preferences Class¶

$PREFS->ini
    $this->EE->config->item

Regular Expressions Class¶

array\_stripslashes()
    strip\_slashes() [$this->EE->load->helper('string');]
ascii\_to\_entities()
    ascii\_to\_entities() [$this->EE->load->helper('text');]
convert\_accented\_characters()
    convert\_accented\_characters()
    [$this->EE->load->helper('text');]
convert\_quotes()
    quotes\_to\_entities() [$this->EE->load->helper('string');]
decode\_qstr()
    Deprecated
encode\_ee\_tags()
    $this->EE->functions->encode\_ee\_tags()
encode\_php\_tags()
    encode\_php\_tags() [$this->EE->load->helper('security');]
entities\_to\_ascii()
    entities\_to\_ascii() [$this->EE->load->helper('text');]
form\_prep()
    form\_prep() [$this->EE->load->helper('form');]
create\_url\_title()
    url\_title() [$this->EE->load->helper('url');]
keyword\_clean()
    sanitize\_search\_terms() [$this->EE->load->helper('search');]
prep\_query\_string()
    $this->EE->functions->prep\_query\_string()
prep\_url()
    prep\_url() [$this->EE->load->helper('url');]
remove\_extra\_commas($str)
    reduce\_multiples($str, ',', TRUE);
    [$this->EE->load->helper('string');]
strip\_quotes()
    strip\_quotes() [$this->EE->load->helper('string');]
trim\_slashes()
    trim\_slashes() [$this->EE->load->helper('string');]
valid\_ip()
    $this->EE->input->valid\_ip()
xml\_convert()
    xml\_convert() [$this->EE->load->helper('xml');]
xss\_clean()
    $this->EE->security->xss\_clean()
xss\_protection\_hash()
    $this->EE->security->xss\_hash()

2.0 Tips and Tricks¶

Template Class¶

Aside from switching from globals to the super object, you don’t HAVE to change your use of the template class. However, make certain to read the 2.0 docs on the Template class, as using it has been greatly simplified. The legacy approach still works, but it may be worth experimenting with the new parse_variables() method, as you will likely want to make use of the streamlined approach in the future.

Note also, the fetch_param() function has been changed so that parameter values of ‘y’, ‘on’ and ‘yes’ all return ‘yes’, while ‘n’, ‘off’ and ‘no’ all return ‘no’. Your module or plugin may need to be changed accordingly.

Be wary of shortcuts using session_start()¶

If you are using session_start() to look at the URL and output content it will no longer work (ex: http://example.com/system/index.php?S=0&ajax=jquery). CI’s routing will see that as a bad request (no controller or method) and will redirect to the EE CP’s homepage.

Instead, you should do is either use our internal JavaScript library -or- actually make the request go to the module proper. For example:

http://example.com/system/index.php?S=0&D=&C=addons\_modules&M=show\_module\_cp&module=tag&method=ajax&jquery=1.

ExpressionEngine 2.0 Syntax Changes¶

General Syntax Changes¶

Change class names for extensions¶

Change class names for module control panels¶

Switch from globals to the super object¶

Switch ‘weblog’ terminology to ‘channel’ terminology¶

Protect your scripts from direct access¶

Paths and Constants¶

Renamed Objects¶

Deprecated Objects¶

Libraries¶

Helper Functions¶

Renamed Functions by (Old) Class¶

Database Class¶

Display Class¶

Email Class¶

Extensions Class¶

Functions Class¶

Input Class¶

Language Class¶

Preferences Class¶

Regular Expressions Class¶

2.0 Tips and Tricks¶

Template Class¶

Be wary of shortcuts using session_start()¶

User Contributed Notes