README

Build enterprise solutions with WordPress.

The Symfony WordPress Backoffice Bundle is a powerful library that seamlessly combines the flexibility of Symfony, a robust PHP framework, with the user-friendliness of WordPress, a popular content management system (CMS).

This bundle enables you to harness Symfony's structure to develop highly customized web applications while using WordPress as the backend for content management. It simplifies the integration of WordPress into your Symfony project, allowing you to leverage the best of both worlds.

How does it work ?

When the WordPress bundle is loaded, it selectively includes the essential WordPress Core files required for utilizing WordPress functions and plugins within Symfony.

Example :

// src/Controller/BlogController.php

/**
 * @param Post $post
 * @param PostRepository $postRepository
 * @return Response
 */
public function pageAction(Post $post, PostRepository $postRepository)
{
    $context = [];
    
    // get current post
    $context['post'] = $post;
    
    // find 10 "guide" ordered by title
    $context['guides'] = $postRepository->findBy(['post_type'=>'guide'], ['title'=>'ASC'], 10);

    return $this->render('page.html.twig', $context);
}

{# templates/page.html.twig #}

{% extends 'layout.html.twig' %}

{% block body %}
<article id="post-{{ post.ID }}" class="entry {{ post.class }}">

    {% if post.thumbnail %}
        <img src="{{ post.thumbnail|resize(800, 600) }}" alt="{{ post.thumbnail.alt }}"/>
    {% endif %}

    <div class="entry-content">
        
        {{ post.content|raw }}
        
        {# or #}
        
        {% for block in post.blocks %}
            {% include 'block/'~block.name~'.html.twig' %}
        {% endfor %}
    </div>
    
    <small>{{ post.custom_fields.mention }}</small>
    
    {% for guide in guides %}
        {% include 'guide.html.twig' with {props:guide} %}
    {% endfor %}

</article>
{% endblock body %}

Documentation

Changelog

Please see Changelog for more information on what has changed recently.

Features

Using Composer :

Install/update WordPress via composer
Install/update plugins via composer

Using Symfony :

Twig template engine
Folder structure
Http Cache
Routing
YML configuration
DotEnv
Enhanced Security ( WordPress is 'hidden' )
Dynamic image resize
MVC

Using WordPress Bundle :

Post/Term/User Repository
Controller argument resolver for post(s), term, user and blog
Symfony Cache invalidation on update ( Varnish compatible )
Post/PostCollection/Image/Menu/Term/User/Comment/Blog/Block entity
Possible use of WordPress predefined routes
Site health checker url

Using WP Steroids WordPress plugin :

WordPress' configuration using yml ( view sample )
Permalink configuration for custom post type and taxonomy
Maintenance mode
Backup download in dev mode
Build hook
Disabled automatic update
Enhanced Security
Better guid using RFC 4122 compliant UUID version 5
Multisite images sync ( for multisite as multilangue )
SVG Support
Better Performance
WordPress Bugfix
CSS Fix
Multisite post deep copy ( with multisite-language-switcher plugin )
Custom datatable support with view and delete actions in admin
Google translate or Deepl integration
Optimisations

YML file allows to configure :

Image options
Maintenance support
Admin pages removal
WYSIWYG MCE Editor
Feature Support
Multi-site configuration
ACF configuration
Menu
Custom Post type
Custom Taxonomy
Block
Page, post, taxonomy template
Page state
Post format
External table viewer
Advanced roles

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Creating a new project

$ composer create-project metabolism/wordpress-skeleton my_project_directory

Please read the full bundle installation guide to continue

Setting up an existing Symfony project

Define installation path for WordPress core and plugins in composer.json

"extra": {
    "installer-paths": {
        "public/wp-bundle/mu-plugins/{$name}/": ["type:wordpress-muplugin"],
        "public/wp-bundle/plugins/{$name}/": ["type:wordpress-plugin"],
        "public/wp-bundle/themes/{$name}/": ["type:wordpress-theme"],
        "public/edition/": ["type:wordpress-core"]
    }
}

Install the bundle

$ composer require metabolism/wordpress-bundle

For applications that don't use Symfony Flex

// config/bundles.php

return [
    // ...
    Metabolism\WordPressBundle\WordPressBundle::class => ['all' => true],
];

Please read the full bundle installation guide to continue

Demo

https://github.com/metabolism/wordpress-bundle-demo

This is an implementation of the Twenty Nineteen WordPress theme for wordpress-bundle.

Recommended / tested plugins

Advanced custom fields Customise WordPress with powerful, professional and intuitive fields.
ACF extensions Extensions for ACF
Classic editor Restores the previous (« classic ») WordPress editor and the « Edit Post » screen.
WP smartcrop Set the 'focal point' of any image, right from the media library
Multisite language switcher Add multilingual support using a WordPress multisite
WordPress seo The favorite WordPress SEO plugin of millions of users worldwide!
Query monitor Query Monitor is the developer tools panel for WordPress
Redirection Easily manage 301 redirections, keep track of 404 errors
Contact form 7 Manage multiple contact forms, plus you can customize the form and the mail contents

Roadmap

More samples
Global maintenance mode for multi-site
Unit tests
Better type hinting

Drawbacks

WordPress' functions are available in the global namespace.

Some WordPress plugins may not work ( ex : Woocommerce ) or require extra works.

Treeware

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

License

The MIT License (MIT). Please see License File for more information.

metabolism / wordpress-bundle

Maintainers

Details