WP Emerge Logo

Packagist Travis branch Scrutinizer Scrutinizer Coverage

📦 A micro framework which modernizes WordPress as a CMS development by providing tools to implement MVC and more.

🔥 Integration is incremental - you can use it only on the pages you want or on all pages.

❤️ If you've used frameworks such as Laravel, Slim or Symfony you'll love WP Emerge.

Requirements

  • PHP >= 5.5
  • WordPress >= 4.7
  • Composer

Features & Documentation

https://docs.wpemerge.com/

API Reference

https://api.wpemerge.com/

Development Team

Brought to you by the lovely folks at htmlBurger

Comparison Table ¹ ²

WPEmerge Sage Timber
View Engine PHP, Blade, Twig, Custom PHP, Blade Twig
Routing
MVC ✖✔✔ ✖✔✖³ ✖✔✖
Middleware
View Composers
Service Container

¹ We are comparing frameworks and themes - style, build tools etc. are not mentioned. For a full comparison you'll have to wait for the official WP Emerge Starter Theme.

² WP Emerge is theme agnostic - you can use it in any theme.

³ Sage's Controller is more a View Model than a Controller.

Features

Routes with optional rewrite rule integration

  • Enables the use of controllers to compartmentalize your business logic away from your presentation.
  • Use existing routes or add new ones with a rewrite.
  • Use built-in dynamic route conditions or define your own custom ones.
  • Use anonymous functions for quick one-off conditions.
Router::get( '/', 'HomeController@index' );

Router::get( '/custom', 'CustomController@custom' )
    ->rewrite( 'index.php?...' );

Router::get( ['post_id', get_option('page_on_front')], 'PostController@index' );

Router::get( function() {
    return is_front_page();
}, 'HomeController@index' );

Controllers

  • Separate unrelated business logic into controllers, and related business logic into controller methods.
  • Receive an object representing the current request and respond with a PSR-7 response.
  • Use different methods for different routes.
  • Respond with a view, json, a redirect etc.
  • Easy to test.
class HomeController {
    public function index( $request ) {
        $name = $request->get( 'name' );
        return app_view( 'templates/home.php' )
            ->with( [
                'welcome' => 'Welcome, ' . $name . '!',
            ] );
    }
}

Middleware

  • Hook before and/or after route handler (e.g. controller method).
  • Add globally or to specific routes or route groups.
  • Powers features such as Flash and OldInput.
Router::get( '/', 'HomeController@index' )
    ->add( function( $request, $next ) {
        // perform action before
        $response = $next( $request );
        // perform action after
        return $response;
    } );

PSR-7 Responses

  • Use PSR-7 objects for your responses.
  • Easy to stream and modify before outputting.
  • Uses Guzzle's implementation - read more.
class HomeController {
    public function index( $request ) {
        return app_response()
            ->withHeader( 'X-Custom-Header', 'foo' );
    }
}

View Composers

  • Pass generic context to partials regardless of which controller or parent view uses them.
  • Work with any View engine (Php, Twig, Blade).
View::addComposer( 'templates/about-us', function( $view ) {
    $view->with( ['hello' => 'world'] );
} );

Service container

  • Define your dependencies in a service container.
  • Override any and all WP Emerge dependencies when needed.
  • Enables automatic dependency injection.
  • Uses Pimple - read more.
$container = WPEmerge::getContainer();
$container['my_service'] = function() {
    return new MyService();
};

Service providers

  • Register dependencies into the service container and boot them, if needed.
  • Enables to split your dependencies logically into separate providers.
  • WP Emerge's own dependencies are provided via Service providers.
class MyServiceProvider implements ServiceProviderInterface {
    public function register( $container ) {
        $container['my_service'] = function() {
            return new MyService();
        };
    }

    public function boot( $container ) {
        // bootstrap code if needed
    }
}

Custom view engine support

  • Replace the view engine used in the service container.
  • Twig and Blade available as add-on packages.
  • You can even write your own view engine and use it seamlessly.
$container = WPEmerge::getContainer();
$container[ WPEMERGE_VIEW_ENGINE_KEY ] = function( $container ) {
    return new MyViewEngine();
};

Contributing

WP Emerge is completely open source and we encourage everybody to participate by:

results matching ""

    No results matching ""