• You can redirect to a URL using the following static method:

$url = "https://www.yourwebsite.com".
e107::redirect($url);

• To redirect to the homepage, simply leave the URL blank.

• To redirect to the Admin Area, use the value 'admin'.

Introduction

.....

Directory constants

Path constants

User constants

General Site Constants

Userclass constants

......

Language constants

Development constants

// define('eDEBUG', true); // Enable debug mode to allow displaying of errors // define('e_HTTP_STATIC', ''); // Use a static subdomain for js/css/images etc. // define('e_MOD_REWRITE_STATIC', true); // Rewrite static image urls. // define('e_LOG_CRITICAL', true); // log critical errors but do not display them to user. // define('e_GIT', 'path-to-git'); // Path to GIT for developers // define('X-FRAME-SAMEORIGIN', false); // Option to override X-Frame-Options // define('e_PDO, true); // Enable PDO mode (used in PHP > 7 and when mysql* methods are not available)

Theme constants

Plugin constants

Core plugins

Social plugin

Plugins extended the functionality of e107 and allow for endless possibilities.

CORE/THIRD PARTY - LINK TO USER GUIDE

ARCHITECTURE

The plugin architecture is developed to be as simple as possible. Often you can copy a file from an existing plugin and simply modify a few parameters in order to get similar functionality in your own plugin

Folder structure

Example: blank plugin

• images

  • sizes?

• languages

Required files

• plugin.xml

Optional files

• admin_config.php

• *_setup.php

• *_sql.php

Introduction

Use the following to retrieve the alerts class object.

Alerts methods

addSuccess()

addError()

addWarning()

addInfo()

addDebug()

render()

None of the above methods will output anything, until you use this method to render them.

Introduction

Cache methods

retrieve()

retrieve_sys()

set()

clear()

clear_sys()

Cache types

The table below provides an overview of the default folder structure of an e107 installation:

Introduction

Your code should not produce any PHP warnings or notices during normal usage. This primarily implies that all variables must be defined before being used. It also implies that a corrupted installation may produce errors, although as far as practicable the code should accommodate this.

Introduction

By far, the quickest and easiest way to develop a plugin for e107 is to use the , because:

• It allows you to select the database file () file from the plugin folder, or directly from the database table list, and it will generate most of the new code for the of your plugin.

• It will generate the new meta-file, which is used during installation of your plugin and also when sharing plugins via this site.

How to use the Plugin Builder

1. Create an empty plugin folder in e107_plugins (eg. "myplugin")

2. Create a new text file with the *_sql.php extension. (eg. "myplugin_sql.php")

3. Using a tool such as phpMyAdmin, create your database table structure, and then export it in SQL format.

Basic info

Database tables

field

caption

type

data

width

batch

filter

inline

validate

display

R/O

Helptip

ReadParms

WriteParms

Preferences

Addons

myplugin_shortcodes.php

Introduction

theme.php

theme.html

Introduction

Include meta tags in the html header.

Returns an array of user data for a specific user. Input can be either a specific ID ($user_id) or use USERID for the currently logged in user.

Introduction

...

Basic CSS methods

Including css in your plugin or theme may be achieved by using the following function:

Examples

Introduction

Introduction

Themes developed for v1.x of e107 will continue to work using v2.x. However, to get the most out of v2.x, it is recommended to make the following changes to bring your theme up to date with the new v2.x standards.

theme.php

• Replace $HEADER and $FOOTER with $HEADER['default'] and $FOOTER['default']

• Replace any occurrences of $CUSTOMHEADER and $CUSTOMFOOTER with $HEADER['custom'] and $FOOTER['custom']

• If you have used index.php in your $CUSTOMPAGES list, use FRONTPAGE instead (see above)

• The function theme_head() has been deprecated. Instead, use either or to include what you require in the header. (see bootstrap or other new core theme for examples)

• Shortcodes need to be set to

Theme shortcodes

Read more on theme shortcodes here:

Introduction

• e107 v2.x is designed for Bootstrap styling. It is therefore encouraged for developers to use bootstrap as their guide for their HTML markup.

• A default Bootstrap 3 is provided with e107. For html markup and examples, please refer to the and for snippets: .

• If you find markup in the core templates of e107 which does not work well with bootstrap, please let us know in the Github issue tracker, so that we may correct it.

style.css

Introduction

Overview

The table below provides a quick overview of all classes that are used in e107 and are commonly used by developers.

Introduction

Introduction

Back in September 2015, . Currently, any older version of e107 (such as version 1.0.4) is considered to be Legacy, and is also referred to as e107 v1.x.

Plugins and themes developed for e107 v1.x will continue to work on v2.x. However, to get the most out of v2.x, it is strongly recommended for developers to make changes to their code and bring the code up to the new v2.x standards.

To create a simple test script, create a new file called helloworld.php in your root folder with the following PHP code:

Then point your browser to www.yoursite.com/helloworld.phpand you're ready!

Welcome to the new Developer Guide for e107.

The Developer Guide is still under construction but more and more information is added over time.

You can use the menu on the left to navigate to the underlying pages.

Introduction

Your website can be used in different languages. In order for your plugin or theme areas to be displayed in a specific language, it needs to be translated.

Language files

File Types

There are three types of language files that can be used in your plugin.

Defining Language Terms

Language Terms are more commonly known as LAN's. You can define LAN's by using PHP constants:

Best practices

👍 Always use the format LAN_PLUGIN_{FOLDER}_{TYPE} to prevent conflicts.

Avoid duplicating terms, particularly in the admin area.

👍 If defining terms for admin, always search lan_admin.php for existing LANs which may match what you require.

Never use HTML or URLs inside LAN definitions.

👍 Use double quotes within the defines and use str_replace() or 👉 for where needed.

Avoid short language strings for common words

Examples are words such as 'and', 'to' and so on. There aren't always equivalents in other languages.

👍 If embedding values into a phrase, use .

Avoid using terms which are real words or known BBCodes.

👍 Use brackets [..] and values such as x, y, z. See below.

Examples

Good

Bad

Substitution

Loading Language Files

e107::lan()

To load a language file from a plugin folder, use e107::lan():

This will include the following paths:

Introduction

Best practices

• Do not modify the core database structure

👍 Use your own tables (for example by ) if you want to work with additional data in the database.

• Do not (ab)use database tables and fields for other purposes

👍 Stick to purposes overview, or create your own database tables

Database prefix

The default database table prefix is e107_ and can be customized by the user during the installation of e107. The prefix that is used on an installation can always be found in the e107_config.php file.

There are several ways the database prefix is used:

1. Recommended: It is strongly recommend to make use of the . Using these methods, the database table prefix is processed automatically.

2. By using the # sign, one can automatically refer to the database prefix. This is generally used when using the method, to manually construct an SQL query.

Database tables overview

The following table provides an overview of all database tables in a clean e107 installation, with their respective purposes.

Introduction

You can generate a Search Engine Friendly (SEF) URLs using the following method:

Examples

Example 1: Forum topic URLs

In this example we will generate search-engine-friendly URLs for a forum topic with the following code: .

The code above loads the following file: e107_plugins/forum/e_url.php and generates a URL from the following array data with the unique key topic:

Only the value of 'sef' is used in this array. it substitutes the values {forum_sef}, {thread_id} and {thread_sef} with the variables in the $data array.

The end result would look something like this:

Example 2: Using optional parameters

Introduction

Introduction

Date methods

computeLapse()

Calculate difference between two dates for display in terms of years/months/weeks....

convert_date()

Convert datestamp to human readable date. System time offset is considered.

terms()

Return an array of language terms representing months

Introduction