diff options
author | zotlabs <mike@macgirvin.com> | 2017-11-01 22:34:31 -0700 |
---|---|---|
committer | zotlabs <mike@macgirvin.com> | 2017-11-01 22:34:31 -0700 |
commit | f23c8e7597b6d96639738d0180e8cb277682ce23 (patch) | |
tree | ffcb15dd536800b67c9918756e41bb4accde3320 /doc/Widgets.md | |
parent | e539a9e7bdd035f96d8e8406e3433d34d99435da (diff) | |
parent | 11cdc36bcc7414002c2e72fd0c45d285d9515f0c (diff) | |
download | volse-hubzilla-f23c8e7597b6d96639738d0180e8cb277682ce23.tar.gz volse-hubzilla-f23c8e7597b6d96639738d0180e8cb277682ce23.tar.bz2 volse-hubzilla-f23c8e7597b6d96639738d0180e8cb277682ce23.zip |
Merge branch 'dev' of https://github.com/redmatrix/hubzilla into dev_merge
Diffstat (limited to 'doc/Widgets.md')
-rw-r--r-- | doc/Widgets.md | 34 |
1 files changed, 32 insertions, 2 deletions
diff --git a/doc/Widgets.md b/doc/Widgets.md index 4ad899a0f..7761b1833 100644 --- a/doc/Widgets.md +++ b/doc/Widgets.md @@ -129,14 +129,44 @@ Some/many of these widgets have restrictions which may restrict the type of page Creating New Widgets ==================== -If you want a widget named 'slugfish', create widget/slugfish.php containing +### Class Widgets + +To create a class-based widget named 'slugfish' create a file with the following contents: + +```` +<?php + +namespace Zotlabs\Widget; + + +class Slugfish { + + function widget($args) { + + ... widget code goes here. + ... The function returns a string which is the HTML content of the widget. + ... $args is a named array which is passed any [var] variables from the layout editor + ... For instance [widget=slugfish][var=count]3[/var][/widget] will populate $args with + ... [ 'count' => 3 ] + + } + +```` + +The resultant file may be placed in widget/Slugfish/Slugfish.php , or Zotlabs/SiteWidgets/Slugfish.php . It also may be linked from a git repository using util/add_widget_repo. + + + +Traditional function based widget: + +If you want a widget named 'slugfish', create widget/widget_slugfish.php containing <?php function widget_slugfish($args) { - .. widget code goes here + .. widget code goes here. See above information for class-based widgets for details. } |