Jump to content

New Module: AppApi

Recommended Posts

3 minutes ago, David Lumm said:

Hey all!

I was wondering, is there any concept of "middleware" or hooks that I could attach to so I could run something on every request?

At the moment I've got a couple of things I've added into every route function, but I can anticipate that list getting longer. Rather than copy and paste the same lines into each and potentially miss something, it would be great if I could run it before the route specific code runs. Is that possible @Sebi?

Hi HI David, in PW any function in a module that has ___ at the start, like ___handleApiRequest() in the AppAPI module you can use as a hook in your own code. See https://processwire.com/docs/modules/hooks/

  • Like 2

Share this post

Link to post
Share on other sites
10 minutes ago, benbyf said:

Hi HI David, in PW any function in a module that has ___ at the start, like ___handleApiRequest() in the AppAPI module you can use as a hook in your own code. See https://processwire.com/docs/modules/hooks/

Ah that's great, thanks! I'll take a look at that and see what I can work out!

Share this post

Link to post
Share on other sites
21 hours ago, Sebi said:

Hi @thibaultvdb,

thank you for reporting this issue! 
I'll be honest: In my Apis I actually always use arrays as return values, so I didn't notice this bug. With version 1.1.2, which I just released, you can use a stdclass again instead of an array as return value. 

I hope everything is running smoothly again with your Api? I would be very happy about a short feedback!

hi @Sebi

Awesome, thanks for the quick feedback and fix. Normally I use a lot of array's myself but I had a specific case where a object was the ideal way to go 😛.
I'll test it out in the following days!
Version 1.1.1 is working good for me, however I'm not doing really special stuff with it at the moment so I'm not sure if my case is the best feedback 😛.
I'm just opening the api  for visitors so I can use it a little like a restApi (doing some fancy ajax stuff) and it's doing exactly what I would expect so great work!

If you want me to check some other parts, let me know!

Share this post

Link to post
Share on other sites

Hi @Sebi, I ran into a bug:

Currently the Router::handleError() function incorrectly reports HTTP 500 errors that result from methods that should have remained silent, because they are called with the error control operator '@'.

As the PHP documentation on error control operators puts it: 


If you have set a custom error handler function with set_error_handler() then it will still get called, but this custom error handler can (and should) call error_reporting() which will return 0 when the call that triggered the error was preceded by an @.

I bumped into this while working on a project with some semi-broken images, where the APP API module kept throwing 500's from PW's ImageInspector class.
Exif issues can be rather difficult to handle sometimes..

The solution is simple: just add a check error_reporting() before the handleError method, for instance

  public static function handleError($errNo, $errStr, $errFile, $errLine)
        if (error_reporting()) {
            $return = new \StdClass();
            $return->error = 'Internal Server Error';
            $return->devmessage = [
                'message' => $errStr,
                'location' => $errFile,
                'line' => $errLine
            self::displayOrLogError($return, 500);



  • Like 1

Share this post

Link to post
Share on other sites

I just released version 1.1.3 which resolves three issues that were reported recently:

  • Fixes an issue with the constructor signature of the modules AppApiException class (by @David Lumm, thanks for PR 🤗)
  • Fixes an issue with the error-handler, which made it mistakenly catch errors that should have been ignored via @ operator (Thanks to @eelkenet)
  • Switched from `wire('input')->url` to `$_SERVER['REQUEST_URI']` for reading the base-url, because ProcessWire's internal function transferred everything to lowercase. (Thanks to Github-user @pauldro)

Thank you all for your contributions!

  • Like 2

Share this post

Link to post
Share on other sites

I've read the doco, installed the module & Twack and no matter what I try when retrieving a page, all I get back is a successful Promise or worse, an error message about invalid json. Using React/Nextjs and the page is published, viewable & using the basic-page template. The authorisation is single JWT and the client JS code is:

export async function PWPageByUrl(path)  {
  // url is correct and returns a result, just not the one I was expecing
    const res = await fetch(`${process.env.NEXT_PUBLIC_API_URL}/${process.env.NEXT_PUBLIC_API_VERSION}/page/${path}`, {
            headers: {
                'x-api-key': process.env.NEXT_PUBLIC_API_KEY,
                'authorization': process.env.NEXT_PUBLIC_TOKEN
    const data = await res.json()
    if (!data) {
        return {
            notFound: true,
    return {
        props: {
        }, // will be passed to the page component as props

On the PW server side as per doco with routes modified for v1, I have:


namespace ProcessWire;

require_once wire('config')->paths->AppApi . "vendor/autoload.php";
require_once wire('config')->paths->AppApi . "classes/AppApiHelper.php";

require_once __DIR__ . '/TwackAccess.class.php';

$routes = [

    'v1' => [
        'page' => [
            ['OPTIONS', '{id:\d+}', ['GET', 'POST', 'UPDATE', 'DELETE']],
            ['OPTIONS', '{path:.+}', ['GET', 'POST', 'UPDATE', 'DELETE']],
            ['OPTIONS', '', ['GET', 'POST', 'UPDATE', 'DELETE']],

            ['GET', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['GET', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['GET', '', TwackAccess::class, 'dashboardRequest'],

            ['POST', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['POST', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['POST', '', TwackAccess::class, 'dashboardRequest'],

            ['UPDATE', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['UPDATE', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['UPDATE', '', TwackAccess::class, 'dashboardRequest'],

            ['DELETE', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['DELETE', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['DELETE', '', TwackAccess::class, 'dashboardRequest'],
        'file' => [
            ['OPTIONS', '{id:\d+}', ['GET']],
            ['OPTIONS', '{path:.+}', ['GET']],
            ['OPTIONS', '', ['GET']],

            ['GET', '{id:\d+}', TwackAccess::class, 'pageIDFileRequest'],
            ['GET', '{path:.+}', TwackAccess::class, 'pagePathFileRequest'],
            ['GET', '', TwackAccess::class, 'dashboardFileRequest']

and the TwackAccess class copy/pasted from the documentation, eg for pagePathRequest:


     * General function for page-outputs:
    protected static function pageRequest(Page $page) {
        // Exit if Twack is not installed
        if (!wire('modules')->isInstalled('Twack')) {
            throw new InternalServererrorException('Twack module not found.');

        // This commands Twack to output a data-array instead of HTML:

        // If the page has no template, is not accessable or is blocked (i.e. via hook),
        // we throw a ForbiddenException
        if (!$page->viewable()) {
            throw new ForbiddenException();

        $ajaxOutput   = $page->render();

        // $ajaxOutput will contain JSON-code, so we have to decode it to prevent it is encoded twice:
        $results      = json_decode($ajaxOutput, true);

        // Now, $results is a clean PHP-array with the information generated by Twack-components:
        return $results;



I'm obviously missing something. Help to get it working as expected much appreciated.



Share this post

Link to post
Share on other sites
4 hours ago, psy said:

I'm obviously missing something. Help to get it working as expected much appreciated.

Hi @psy,

At first glance, I can't find any obvious error in your code. Can you please show me the server response you get for the "Invalid Json" errors? (You can see each request/response in your browser's developer-console in the network-tab. Feel free to DM me if you need support for that.)

I would try to take out some complexity first and leave Twack out of the queries for now. It's best to set up a test route that only returns a simple response. Insert this to your Routes.php:

'v1' => [
    'test' => [
        ['OPTIONS', '', ['GET']],
            ['GET', '', AppApiTest::class, 'test']

And create the AppApiTest-class:


namespace ProcessWire;

class AppApiTest {
    public static function test($data) {
        return [
          'test' => true,
          'success' => 'YEAH!'

No token-authentication needed. If you get this response back in Javascript, we can be sure that the basic api connection works.

Share this post

Link to post
Share on other sites

@Sebi Thanks for the quick response. I'd already gone past that point both in PW and Postman so the connection is good.

I'd even written my own method in Examples to get a page by ID. Maybe not as sophisticated as yours but it too worked:

<?php namespace ProcessWire;

Class Example {
  	public static function test () {
		return ['test successful'];

      public static function getPageById($data) {
        $data = AppApiHelper::checkAndSanitizeRequiredParameters($data, ['id|int']);

        $p = wire('pages')->get("id=$data->id");
        if(!$p->id) throw new \Exception('Page not found', 404);

        $response = new \StdClass();

        // Hardcode any data you need that does not have an inputfield field in the admin
        $response->id = $p->id;
        $response->name = $p->name;
        $response->path = $p->path;

        // This retrieves all the admin input fields. Does not (yet) get page images or files, just single entry data
        $fields = $p->getFields();
        foreach ($fields as $fld) {
            $fldName = $fld->name;
            $response->$fldName = $p->$fld;

        return $response;

This enabled me to get the page data into the NextJS client and embed in the 'template/component' as variables from any existing PW page.

My next exercise was to delve into the NextJS router so that I could retrieve pages via their path and those paths would appear in the URL. Couldn't work it out in my own PW code (no surprises there!). It was then I installed your Twack module and used the Twack routes & TwackAccess.class.php at which point I ran into the issues mentioned above.

I'm sure it's my lack of knowledge of REACT/NextJS rather than your code... Doesn't help when their doco doesn't match up with their examples in gitHub.

Even so, it would great to use your TwackAccess classes rather than reinventing the wheel.




Share this post

Link to post
Share on other sites

@psy So, just to make sure, that everything works well on the PHP side: You can make a request via Postman to the same url that you are trying to access via Javascript? And you get back the expected JSON-data?

Unfortunately, I don't know much about NextJS and React. I am actually an Angular or Vanilla Javascript developer. In an Angular environment I would use Angular's httpClient to make an api-call:

const params = new HttpHeaders({
	'x-api-key': environment.api_key
	response => console.log("Api-Response: ", response)

I assume that React has a similar helper class as well. This makes a call to the page-route in my router-definition, which you can see here: https://github.com/Sebiworld/musical-fabrik.de/blob/master/site/api/Routes.php . It will return the ajax-results for the ProcessWire page with id 1042 in this case.

I prefer to use the httpClient (if available) instead of the fetch function, which you are using in your code-example above. Mainly because I found the fetch function very cumbersome to use when dealing with more complex parameter data. But for a vanilla-js project I needed to use it, so I wrote a helper class that is way more usable: https://github.com/Sebiworld/musical-fabrik.de/blob/master/site/templates/src/js/classes/AjaxCall.js

Here is how you can make an api-call:

const ajaxCall = new AjaxCall({
	method: 'GET',
	path: '/api/page/1042',
	headers: {
		'X-API-KEY': 'oiasnduz3498gfsubasd'
  console.log('Api-response: ', response);
  console.log('Api-error: ', response);

I hope that helps you out 😊

  • Like 1

Share this post

Link to post
Share on other sites

I released v1.1.4 of AppApi. The update fixes a critical bug that occurred when routes were called with GET parameters.  (reported by @David Lumm, thanks for PR 🤗)

Because I was already at it, I outsourced the reading of the current route (which is then further used by FastRoute) to its own hookable function `___getCurrentUrl()`. This allows you in special use cases to subsequently influence the URL with your own hook function.

Share this post

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

      Renders an overview of all available replacements (see the example in the Module's config file:
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
    • By bernhard
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
  • Create New...