You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generates required add-on files in the `system/user/addons` directory.
4
+
5
+
TIP: Read the [Add-on Development Overview](development/addon-development-overview.md) to learn more about creating an add-on.
6
+
7
+
## Options list:
8
+
9
+
The first (unnamed) parameter is the add-on name.
10
+
11
+
Other options are:
12
+
```
13
+
--version=<value>
14
+
-v <value>
15
+
Version of the add-on
16
+
17
+
--description=<value>
18
+
-d <value>
19
+
Description of the add-on
20
+
21
+
--author=<value>
22
+
-a <value>
23
+
Author of the add-on
24
+
25
+
--author-url=<value>
26
+
-u <value>
27
+
Author url of the add-on
28
+
```
29
+
## Examples:
30
+
31
+
### Interactive example
32
+
```
33
+
$ php system/ee/eecli.php make:addon
34
+
Let's build your add-on!
35
+
What is the name of your add-on? Amazing Add-On
36
+
Add-on description? [Amazing Add-on description] This add-on does amazing things!
37
+
Add-on version? [1.0.0]1.0.0
38
+
Add-on author? ExpressionEngine Developer
39
+
Add-on author URL? www.expressionengine.com
40
+
Let's build!
41
+
Your add-on has been created successfully!
42
+
```
43
+
44
+
### One-line example
45
+
46
+
`php ../../system/ee/eecli.php make:addon "My Example Addon" -v 0.1.0 -d "Some good description" -a "ExpressionEngine" -u https://expressionengine.com`
Copy file name to clipboardExpand all lines: docs/development/add-on-update-file.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,13 @@
11
11
12
12
## Overview
13
13
14
-
The `upd.[addon_name].php` file (commonly just called the `upd` file) is critical to ExpressionEngine knowing what to do with your add-on. Here we tell ExpressionEngine what actions to register, core hooks we want to use, database tables to update, and much more. We need to tell ExpressionEngine what to do when we install an add-on, update an add-on, and uninstall and add-on. Thankfully the CLI takes care of most of this for us.
14
+
The `upd.[addon_name].php` file (commonly just called the `upd` file) is critical to ExpressionEngine knowing what to do with your add-on. Here we tell ExpressionEngine what actions to register, core hooks we want to use, database tables to update, and much more. We need to tell ExpressionEngine what to do when we install an add-on, update an add-on, and uninstall and add-on. Thankfully the CLI takes care of most of this for us.
15
15
16
16
TIP:When using the CLI, your add-on update file will automatically be created for you. See [Building An Add-On: Getting Started](development/addon-development-overview.md#getting-started) for how to generate the starter files for your add-on.
17
17
18
18
## Initial Setup
19
19
20
-
When you first create your add-on using the [`make:addon`](development/addon-development-overview.md) command from the CLI, a `upd` file is created for you in the root of your add-on.
20
+
When you first create your add-on using the [`make:addon`](cli/built-in-commands/make-addon.md) command from the CLI, a `upd` file is created for you in the root of your add-on.
21
21
22
22
Here I have created an add-on called Amazing Add-on using the CLI.
23
23
@@ -131,12 +131,12 @@ Be sure that you also update your [`install()` function](#adding-publish-tabs) t
131
131
132
132
133
133
## Update Your Add-on (`update()`)
134
-
The `update` method will run code when a user installs an update to our add-on.
134
+
The `update` method will run code when a user installs an update to our add-on.
Copy file name to clipboardExpand all lines: docs/development/addon-development-overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Here are some ideas of what you can accomplish with a custom add-on:
32
32
These are just a few ideas of what you can do with custom add-ons. The possibilities are almost endless.
33
33
34
34
## Getting Started
35
-
Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the `make:addon` command from the [CLI](cli/intro.html).
35
+
Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the [`make:addon` command](/cli/built-in-commands/make-addon.md) from the [CLI](/cli/intro.html).
36
36
37
37
TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
0 commit comments