wiryonolau/laminas-wordpress

Wordpress Base Plugin using Laminas

dev-master 2020-05-10 04:30 UTC

Requires

• php: ^7.2
• laminas/laminas-mvc: ^3.1
• laminas/laminas-navigation: ^2.9
• laminas/laminas-session: ^2.9

GPL-2.0-or-later

• Wiryono Lau

• wordpress
• laminas

README

Library to create wordpress plugin using Laminas Framework 3 MVC Application

Installation

Using Composer

composer require wiryonolau/laminas-wordpress

Usage

your-plugin-file.php

<?php
require_once plugin_dir_path(__FILE__). '/vendor/autoload.php';

$laminasWordpress = new LaminasWordpress\Application();
$laminasWordpress->setPluginDirectory(plugin_dir_path(__FILE__))
            ->setPluginFile(__FILE__)
            ->setRoutePrefix("my_plugin_prefix")
            ->setTablePrefix("my_db_prefix")
            ->enableSession()
            ->run();
?>

config/application.config.php

module Laminas\Navigation, Laminas\Router, Laminas\Session already included

<?php

return [
    "modules" => [
        "LaminasWordpress"
    ]
];

?>

config/router.config.php

<?php

return [
    "router" => [
        "routes" => [
            "plugin_admin_page" => [
                "type" => "WpAdminRoute",
                "options" => [
                    "route" => "/plugin_admin_page_without_route_prefix"
                    "defaults" => [
                        "controller" => "Your controller"
                        "action" => "action"
                    ]
                ]
            ]
        ]
    ]
]

?>

Using UrlHelper on view

Since all url in admin are translated to a query "admin.php?page=" when assembling route, passing "query" options to url helper will break the url due to TreeRouteStack injecting query options after assembling route. You must pass everything as parameters, which then will be converted to query by WpAdminRoute.

You could define your own TreeRouteStack if neccessary and pass it to array("router" => array("router_class" => ""))

<?php
# Do this
$this->url(
    "your page without namespace",
    array(
        "param1" => "your parameter"
        "param1" => "your parameter and so on"
    )
);

# Instead of this
$this->url(
    "your page without namespace",
    array(),
    array(
        "query" => array(
            "param1" => "your parameter"
            "param1" => "your parameter and so on"
        )
    )
);
?>

Limitation

• wpAdminRoute does not support child_routes at the moment. If you add child_routes it will thrown an exception.
• Wordpress navigation menu only support single nested level navigation.