Skip to content

Key2Host/woltlab-helloworld

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WoltLab HelloWorld Plugin

A simple example plugin that adds a "Hello World" page to your WoltLab Suite installation. Ideal for learning how to structure and develop your own WoltLab plugins.


🔧 1. Build the Package

Run the following command inside your project directory to build the package:

bash build.sh

This will create a .tar file inside the project folder.

📦 2. Install in the ACP

Log in to your Admin Control Panel (ACP).

Go to ConfigurationPackagesInstall PackageUpload Package.

Upload the generated .tar file and complete the installation process.

✅ 3. Test the Page

After installation, visit the following URL in your browser:

https://your-domain.com/index.php?hello-world/

If everything is set up correctly, you’ll see your Hello World page displayed.


🧩 About

This plugin serves as a minimal, educational example for WoltLab developers.

It demonstrates how to:

  1. Create a basic page using WoltLab’s page system
  2. Package and distribute a plugin
  3. Use templates and page controllers

📂 Folder Structure

Example project structure:

woltlab-helloworld/
├─ files/
│  ├─ lib/
│  │  └─ page/
│  │     └─ HelloWorldPage.class.php
│  └─ templates/
│     ├─ helloWorld.tpl
├─ package.xml
├─ page.xml
└─ build.sh

💡 Tip: Use this project as a starting point for your own plugins — just replace the HelloWorld logic with your own functionality.

More help oder definitions on https://docs.woltlab.com/6.2/getting-started/