abigegg

<p>Hatch is a helper library for developers which makes it more pleasant to build websites using Timber, Advanced Custom Fields Pro and other common plugins.</p>
<h3>What is this thing?</h3>
<p>Hatch is a helper library for developers which makes it more pleasant to build websites using Timber, Advanced Custom Fields Pro and other common plugins.</p>
<h3>Requirements</h3>
<p>Timber (latest version.)</p>
<h3>A better way to use Timber</h3>
<p>Using <a href="https://en-gb.wordpress.org/plugins/timber-library/" rel="nofollow ugc">Timber</a> we can use Twig templates to build our sites rather than PHP.</p>
<p>Typically we set up a Timber context like this:</p>
<pre><code>$context = Timber::get_context();

$context['post'] = Timber::get_post();

function website_get_related_posts() {
    // do something fancy here

    return [];
}

$context['related_posts'] = website_get_related_posts();

Timber::render( 'post.twig', $context );
</code></pre>
<p>This is <em>fine</em> but it can get a bit mucky – especially if we have complicated page templates with lots of variables.</p>
<p>Hatch provides a tidier way of setting up contexts for Timber and other popular libraries:</p>
<pre><code>// 'post' is already added by default

Hatch::add_context( 'related_posts', function() {
    // do something fancy
    return [];
} );

Hatch::render( 'post.twig' ); // no need to pass $context in 
</code></pre>
<p>More & better documentation to come! Look in abe-hatch.php for more info</p>
<h3>License</h3>
<p>Copyright 2020 A Big Egg (David Hewitson Ltd)</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.%</p>


Hatch

Hatch is a helper library for developers which makes it more pleasant to build websites using Timber, Advanced Custom Fields Pro and other common plug …

Carlos

<h4>This plugin is intended to be useful for template developers</h4>
<h4>New in version 0.4</h4>
<ul>
<li>added ‘object’ (page object) in every $default_theme_pages item for fast access.</li>
<li>added all default pages to wp toolbar, inside ‘site name’, to increase user experience.</li>
</ul>
<h4>How to use</h4>
<p>Add this code in your <em>functions.php</em>.</p>
<pre><code>global $default_theme_pages;
$default_theme_pages = array(
    array(
        'name' => 'home',               // initial slug page / id for templating - access functions
        'title' => 'Homepage',          // page title
        'option' => 'page_on_front',    // option page id ( stores the page id in an option, use only in theese cases)
        'description' => 'homepage'     // description
    ),
    array(
        'name' => 'blog',
        'title' => 'Blog',
        'option' => 'page_for_posts',
        'description' => 'blog'
    ),
    array(
        'name' => 'contact',
        'title' => 'Contact me!',
        'description' => 'Contact form page'
    )
 );
</code></pre>
<h4>Tips</h4>
<ul>
<li>After the pages are created automatically, you can change their title and slug without problem.</li>
<li>If you add an <code>option</code> names: <code>page_on_front</code> and <code>page_for_posts</code>, you will block the <em>home-page</em> and the <em>blog-page</em> on your site.</li>
</ul>
<h4>Templating</h4>
<p>You can template using <strong>ID</strong> or <strong>name</strong> (setted up in $default_theme_pages global variable ), something like:</p>
<p><strong>page-131.php</strong> or <strong>page-contact.php</strong> (If you change the page slug, this will still work because ‘contact’ was defined as <em>pagename</em> if $default_theme_pages global variable).</p>
<p>For detect if you’re in that page:</p>
<pre><code>dtp_is_page('contact')
</code></pre>
<p>Getting a default page id:</p>
<pre><code>$page_id = dtp_get_page_id('contact');
</code></pre>
<p>This method is more quick than <em>get_page_by_path</em> because page ID is stored on global variable.</p>


Default Theme Pages

Adds unremovable default pages for templating themes

Hatch vs Default Theme Pages