Including and bootstrapping ProcessWire

Use ProcessWire’s API in other PHP apps and shell scripts… It’s easy!

ProcessWire's API and data can be used from other PHP scripts, including command line PHP scripts. This is a simple matter of just including ProcessWire's ./index.php file from any other PHP script.

include("/path/to/processwire/index.php"); 

It doesn't matter if your intended use is HTTP or command line... ProcessWire will auto-detect the state from which it was included.

Once you've included ProcessWire like in the example above, the API is now available to you, just like in template files. For example, here is how you would retrieve a fictional "Contact Us" page from ProcessWire's $pages API variable. Each line below is equivalent, so what syntax best suits your needs:

$mypage = $pages->get("/about/contact/");
$mypage = pages()->get("/about/contact/");
$mypage = $wire->pages->get("/about/contact/");
$mypage = wire('pages')->get("/about/contact/"); 

Note that if using pages() or wire('pages') with ProcessWire 3.x, you'll need to call them from the ProcessWire namespace. You can do this by having a namespace ProcessWire; at the top of your PHP file, or by referencing the namespace directly, i.e. \ProcessWire\wire('pages')->get(…);

You can access all of the same API variables that you can from a template, except that there is no default $page variable accessible from the API since ProcessWire is not handling the web request. Of course, you are welcome to retrieve any page you want from the $pages API variable. Likewise you can modify, save, and delete pages as usual.

Creating a ProcessWire command-line script

Here is an example of a command line shell script called sitemap.sh that outputs all pages in the site in an indented site map. We do this with a very small amount of code by creating a function called listPage that we use recursively:

#!/usr/bin/php
<?php namespace ProcessWire;
include("/home/ryan/www/index.php"); // bootstrap ProcessWire
function listPage($page, $level = 0) {
  echo str_repeat("  ", $level) . $page->title . "\n";
  foreach($page->children as $child) {
    listPage($child, $level+1);
  }
}
listPage($pages->get("/")); // start at homepage

Note that you would need to replace the lines containing paths to have the equivalent paths on your machine (lines 1 and 3). You would also make the shell script executable, i.e.

chmod +x sitemap.sh

Next you would run the shell script:

./sitemap.sh

And here is what the output looked like when I ran it here:

Home
    About
        What's Unique?
        Why ProcessWire?
        Background
        Requirements
        License
    Developer API
        Concept
        What is the API?
        Directories
        Template Files
        Variables
            $page
            $pages
            $input
            $sanitizer
        Selectors
        Syntax
        Plugin Modules
    Download
    Demo
    Videos
    Contact


Including ProcessWire from another PHP script

ProcessWire can be included from any other PHP script in the same manner it was included from the command line script above. Just include ProcessWire's root ./index.php file, and you have full access to it's API.

We'll use the same example as in the shell script above, except that we'll use markup to make an HTML5 page with semantic lists and links to each page. We'll call this file sitemap.php and assume it lives in the web root where ProcessWire's index.php file is:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <title>Site Map</title>
</head>
<body>
    <h1>Site Map</h1>
    <?php
    include("./index.php"); // bootstrap ProcessWire
    function listPage($page, $level = 0) {
        echo "<li><a href='$page->url'>$page->title</a>";
        if($page->numChildren) {
            echo "<ul>";
            foreach($page->children as $child) listPage($child, $level+1);
            echo "</ul>";
        }
        echo "</li>";
    }
    ?>
    <ul>
      <?php listPage($pages->get("/")); ?>
    </ul>
    </body>
</html>

You can do anything with ProcessWire's API that you can do from a template, so everything you can do in template files still applies, as does everything in the developer API.

Twitter updates

  • New ProcessWire query expansion search operators can now add automatic word inflections and lemmatisation, enabling you to build even smarter search engines with ProcessWire. More
    3 July 2020
  • ProcessWire 3.0.161 adds support for selector operator stacking, enabling you automatically broaden searches in a single pages.find() call— More
    26 June 2020
  • ProcessWire 3.0.160 adds powerful new text-searching operators, bringing a new level of power to page-finding API calls, especially when it comes to search engine type queries. Post also includes a demo search engine where you can test it all out live— More
    19 June 2020

Latest news

  • ProcessWire Weekly #321
    In the 321st issue of ProcessWire Weekly we're going to check out the latest core updates, introduce two new third party modules, and check out a brand new site of the week. Read on!
    Weekly.pw / 4 July 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer