Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Use Wordpress and Symfony together using a Symfony bundle
https://github.com/metabolism/wordpress-bundle

bundle composer dotenv symfony symfony-bundle wordpress wordpress-bundle wordpress-development yml

Last synced: 27 days ago
JSON representation

Use Wordpress and Symfony together using a Symfony bundle

Host: GitHub
URL: https://github.com/metabolism/wordpress-bundle
Owner: metabolism
License: mit
Created: 2018-02-21T07:59:27.000Z (over 6 years ago)
Default Branch: 2.3.x
Last Pushed: 2024-07-11T14:31:00.000Z (4 months ago)
Last Synced: 2024-10-07T03:26:51.852Z (30 days ago)
Topics: bundle, composer, dotenv, symfony, symfony-bundle, wordpress, wordpress-bundle, wordpress-development, yml
Language: PHP
Homepage:
Size: 1010 KB
Stars: 59
Watchers: 4
Forks: 17
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Symfony WordPress Bundle

Build enterprise solutions with WordPress.

[![Latest Stable Version](http://poser.pugx.org/metabolism/wordpress-bundle/v)](https://packagist.org/packages/metabolism/wordpress-bundle)

[![Total Downloads](http://poser.pugx.org/metabolism/wordpress-bundle/downloads)](https://packagist.org/packages/metabolism/wordpress-bundle)

[![Latest Unstable Version](http://poser.pugx.org/metabolism/wordpress-bundle/v/unstable)](https://packagist.org/packages/metabolism/wordpress-bundle)

[![License](http://poser.pugx.org/metabolism/wordpress-bundle/license)](https://packagist.org/packages/metabolism/wordpress-bundle)

[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/metabolism/wordpress-bundle)

[![Doc - Gitbook](https://img.shields.io/badge/Doc-Gitbook-346ddb?logo=gitbook&logoColor=fff)](https://metabolism.gitbook.io/symfony-wordpress-bundle/)

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 :__

```php

// 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);

}

```

```twig

{# templates/page.html.twig #}

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

{% block body %}

    {% if post.thumbnail %}

        

    {% endif %}

    


        

        {{ post.content|raw }}

        

        {# or #}

        

        {% for block in post.blocks %}

            {% include 'block/'~block.name~'.html.twig' %}

        {% endfor %}

    

    

    {{ post.custom_fields.mention }}

    

    {% for guide in guides %}

        {% include 'guide.html.twig' with {props:guide} %}

    {% endfor %}

{% endblock body %}

```

## Documentation

- [WordPress Bundle Documentation](https://metabolism.gitbook.io/symfony-wordpress-bundle/)

- [WP Steroids WordPress plugin](https://metabolism.gitbook.io/symfony-wordpress-bundle/guides/wp-steroids-plugin)

- [Installation / Getting started](https://metabolism.gitbook.io/symfony-wordpress-bundle/getting-started/installation)

- [Twig Cookbook](https://metabolism.gitbook.io/symfony-wordpress-bundle/guides/twig-cookbook)

## Changelog

Please see [Changelog](https://metabolism.gitbook.io/symfony-wordpress-bundle/extras/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](https://github.com/metabolism/wp-steroids) WordPress plugin :

* WordPress' configuration using yml ( [view sample](config/wordpress.yaml) )

* 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/Carbon Fields 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](https://getcomposer.org/doc/00-intro.md)

of the Composer documentation.

### Creating a new project

```shell

$ composer create-project metabolism/wordpress-skeleton my_project_directory

```

Please read the full [bundle installation guide](https://metabolism.gitbook.io/symfony-wordpress-bundle/getting-started/wordpress) to continue

### Setting up an existing Symfony project

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

```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

```shell

$ composer require metabolism/wordpress-bundle

```

#### For applications that don't use Symfony Flex

Register the bundle

```php

// config/bundles.php

return [

    // ...

    Metabolism\WordPressBundle\WordPressBundle::class => ['all' => true],

];

```

Please read the full [bundle installation guide](https://metabolism.gitbook.io/symfony-wordpress-bundle/getting-started/wordpress) to continue

## Demo

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

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

[![Screenshot from 2021-05-03 10-08-22](https://user-images.githubusercontent.com/4919596/116854347-d8f2e180-abf7-11eb-9dec-29480cffa720.png)](https://user-images.githubusercontent.com/4919596/116854347-d8f2e180-abf7-11eb-9dec-29480cffa720.png)

## Recommended / tested plugins

- [Advanced custom fields](https://wordpress.org/plugins/advanced-custom-fields) Customise WordPress with powerful, professional and intuitive fields.

- [ACF extensions](https://github.com/metabolism/acf-extensions) Extensions for ACF

- [Classic editor](https://wordpress.org/plugins/classic-editor) Restores the previous (« classic ») WordPress editor and the « Edit Post » screen.

- [WP smartcrop](https://wordpress.org/plugins/wp-smartcrop) Set the 'focal point' of any image, right from the media library

- [Multisite language switcher](https://wordpress.org/plugins/multisite-language-switcher) Add multilingual support using a WordPress multisite

- [WordPress seo](https://wordpress.org/plugins/wordpress-seo) The favorite WordPress SEO plugin of millions of users worldwide!

- [Query monitor](https://wordpress.org/plugins/query-monitor) Query Monitor is the developer tools panel for WordPress

- [Redirection](https://wordpress.org/plugins/redirection) Easily manage 301 redirections, keep track of 404 errors

- [Contact form 7](https://wordpress.org/plugins/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](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/metabolism/wordpress-bundle) 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](LICENSE) for more information.