aboutsummaryrefslogtreecommitdiff
path: root/documentation/examples/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/examples/plugins')
-rw-r--r--documentation/examples/plugins/README.txt4
-rw-r--r--documentation/examples/plugins/start.php22
2 files changed, 25 insertions, 1 deletions
diff --git a/documentation/examples/plugins/README.txt b/documentation/examples/plugins/README.txt
index 9eb04391d..704f56598 100644
--- a/documentation/examples/plugins/README.txt
+++ b/documentation/examples/plugins/README.txt
@@ -1,3 +1,5 @@
Plugin Skeleton
=========================
-
+This directory includes a plugin skeleton to be used as the starting point when
+creating a new plugin. Just create a new directory in /mod/ and copy the files
+and directories into it. Then update the manifest and start coding. \ No newline at end of file
diff --git a/documentation/examples/plugins/start.php b/documentation/examples/plugins/start.php
index e69de29bb..3af50ce38 100644
--- a/documentation/examples/plugins/start.php
+++ b/documentation/examples/plugins/start.php
@@ -0,0 +1,22 @@
+<?php
+/**
+ * Describe plugin here
+ */
+
+elgg_register_event_handler('init', 'system', 'my_plugin_init');
+
+function my_plugin_init() {
+ // Rename this function based on the name of your plugin and update the
+ // elgg_register_event_handler() call accordingly
+
+ // Register a script to handle (usually) a POST request (an action)
+ $base_dir = elgg_get_plugins_path() . 'my_plugin/actions/my_plugin';
+ elgg_register_action('my_plugin', "$base_dir/my_action.php");
+
+ // Extend the main CSS file
+ elgg_extend_view('css/elgg', 'my_plugin/css');
+
+ // Add a menu item to the main site menu
+ $item = new ElggMenuItem('my_plugin', elgg_echo('my_plugin:menu'), 'my_url');
+ elgg_register_menu_item('site', $item);
+}