EkinoWordpressBundle

KO | EN

gitlite — search

#python #react #typescript #golang #go #android #docker #nodejs #macos #java #vue #security #pytorch #openai

EkinoWordpressBundle

(★ 310)

Integrate Symfony with WordPress and WordPress with Symfony

File Explorer

Download Latest Version (.zip)

- WordpressController.php
- - RegisterMappingsPass.php
- Configuration.php
- EkinoWordpressExtension.php
- Comment.php
- CommentMeta.php
- Link.php
- Option.php
- Post.php
- PostMeta.php
- Term.php
- TermRelationships.php
- TermTaxonomy.php
- User.php
- UserMeta.php
- - UserHookListener.php
- - LoadMetadataSubscriber.php
  - WordpressResponseSubscriber.php
- WordpressEvent.php
- WordpressRequestListener.php
- BaseManager.php
- CommentManager.php
- CommentMetaManager.php
- LinkManager.php
- OptionManager.php
- PostManager.php
- PostMetaManager.php
- TermManager.php
- TermRelationshipsManager.php
- TermTaxonomyManager.php
- UserManager.php
- UserMetaManager.php
- Comment.php
- CommentMeta.php
- Link.php
- Option.php
- Post.php
- PostMeta.php
- Term.php
- TermRelationships.php
- TermTaxonomy.php
- User.php
- UserMeta.php
- WordpressContentInterface.php
- WordpressEntityInterface.php
- CommentMetaRepository.php
- CommentRepository.php
- LinkRepository.php
- OptionRepository.php
- PostMetaRepository.php
- PostRepository.php
- TermRelationshipsRepository.php
- TermRepository.php
- TermTaxonomyRepository.php
- UserMetaRepository.php
- UserRepository.php
- - hooks.xml
  - i18n.xml
  - listener.xml
  - manager.xml
  - routing.xml
  - services.xml
  - twig.xml
- WordpressEntryPoint.php
- TablePrefixSubscriber.php
- - WordpressControllerTest.php
- - CommentMetaTest.php
  - CommentTest.php
  - LinkTest.php
  - OptionTest.php
  - PostMetaTest.php
  - PostTest.php
  - TermRelationshipsTest.php
  - TermTaxonomyTest.php
  - TermTest.php
  - UserMetaTest.php
  - UserTest.php
- - WordpressEventTest.php
- - WordpressRequestListenerTest.php
- - OptionManagerTest.php
  - PostManagerTest.php
  - PostMetaManagerTest.php
- - WordPressEntryPointTest.php
- - WordpressTest.php
- autoload.php.dist
- bootstrap.php
- - CommentExtension.php
  - OptionExtension.php
  - PostExtension.php
  - PostMetaExtension.php
  - TermTaxonomyExtension.php
  - ThemeExtension.php
- Wordpress.php
- WordpressResponse.php
.gitignore
.travis.yml
composer.json
EkinoWordpressBundle.php
LICENSE
phpunit.xml.dist
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

EkinoWordpressBundle
====================

[![Build Status](https://secure.travis-ci.org/ekino/EkinoWordpressBundle.png?branch=master)](http://travis-ci.org/ekino/EkinoWordpressBundle) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/e842da81-16e2-47ee-9966-5112bbe1ab9c/mini.png)](https://insight.sensiolabs.com/projects/e842da81-16e2-47ee-9966-5112bbe1ab9c)

This bundle is used to bring some Symfony services into Wordpress and manipulates Wordpress using Symfony.

Here are some features:

* Use custom Symfony services into Wordpress,
* Use Symfony to manipulate Wordpress database,
* Create custom Symfony routes out of Wordpress,
* When authenticated on Wordpress, authenticated on Symfony too with correct user roles. *(requires ekino-wordpress-symfony Wordpress plugin)*
* Catch some Wordpress hooks to be dispatched by Symfony EventDispatcher *(requires ekino-wordpress-symfony Wordpress plugin)*

---

## Installation

Idea of this installation tutorial is to have WordPress rendered by web root with the following architecture:

```
project
|-- wordpress (web root)
|-- symfony (not available over HTTP)
```

### 1) Install Symfony and WordPress

Install your Wordpress project in a `wordpress` directory by unzipping the latest WordPress sources from https://www.wordpress.org.
Install Symfony using composer (for instance, or new Symfony Installer tool) in a `symfony` directory:

```
$ php composer.phar create-project symfony/framework-standard-edition symfony/
```

### 2) Install ekino/wordpress-bundle into Symfony's project

Edit `symfony/composer.json` file to add this bundle package:

```yml
"require": {
    ...
    "ekino/wordpress-bundle": "dev-master"
},
```

Run `php composer.phar update ekino/wordpress-bundle`

Then, add the bundle into `symfony/app/AppKernel.php`:

```php
<?php
    public function registerBundles()
    {
        $bundles = array(
            ...
            new Ekino\WordpressBundle\EkinoWordpressBundle(),
        );

...

return $bundles;
    }
```

Add the WordpressBundle routing file in your `symfony/app/config/routing.yml`, after your custom routes to catch all Wordpress routes:

```yml
...
ekino_wordpress:
    resource: "@EkinoWordpressBundle/Resources/config/routing.xml"
```

Edit your configuration and specify the following options in your `app/config.yml`:

```yml
ekino_wordpress:
    globals: # If you have some custom global variables that WordPress needs
        - wp_global_variable_1
        - wp_global_variable_2
    table_prefix: "wp_" # If you have a specific Wordpress table prefix
    wordpress_directory: "%kernel.root_dir%/../../wordpress"
    load_twig_extension: true # If you want to enable native WordPress functions (ie : get_option() => wp_get_option())
    enable_wordpress_listener: false # If you want to disable the WordPress request listener
    security:
        firewall_name: "secured_area" # This is the firewall default name
        login_url: "/wp-login.php" # Absolute URL to the wordpress login page
```

Also optionally, if you want to use `UserHook` to authenticate on Symfony, you should add this configuration to your `symfony/app/security.yml`:

```yml
security:
    providers:
        main:
            entity: { class: Ekino\WordpressBundle\Entity\User, property: login }

# Example firewall for an area within a Symfony application protected by a WordPress login
    firewalls:
        secured_area:
            pattern:    ^/admin
            access_denied_handler: ekino.wordpress.security.entry_point
            entry_point: ekino.wordpress.security.entry_point
            anonymous: ~

access_control:
        - { path: ^/admin, roles: ROLE_WP_ADMINISTRATOR }
```

### 3) Update your WordPress index.php file to load Symfony libraries

```php
<?php

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Debug\Debug;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Retrieves or sets the Symfony Dependency Injection container
 *
 * @param ContainerInterface|string $id
 *
 * @return mixed
 */
function symfony($id)
{
    static $container;

if ($id instanceof ContainerInterface) {
        $container = $id;
        return;
    }

return $container->get($id);
}

$loader = require_once __DIR__.'/../symfony/var/bootstrap.php.cache';

// Load application kernel
require_once __DIR__.'/../symfony/app/AppKernel.php';

$sfKernel = new AppKernel('dev', true);
$sfKernel->loadClassCache();
$sfKernel->boot();

// Add Symfony container as a global variable to be used in Wordpress
$sfContainer = $sfKernel->getContainer();

if (true === $sfContainer->getParameter('kernel.debug', false)) {
    Debug::enable();
}

symfony($sfContainer);

$sfRequest = Request::createFromGlobals();
$sfResponse = $sfKernel->handle($sfRequest);
$sfResponse->send();

$sfKernel->terminate($sfRequest, $sfResponse);
```

### 4) In the case you expose Symfony only

To avoid problem with some Wordpress plugin, you need to wrap `web/app.php` code inside a function like this:

```php
<?php
use Symfony\Component\HttpFoundation\Request;

// change for app_dev.php
function run(){
    $loader = require_once __DIR__.'/../var/bootstrap.php.cache';

require_once __DIR__.'/../app/AppKernel.php';

$kernel = new AppKernel('dev', true);
    $kernel->loadClassCache();
    Request::enableHttpMethodParameterOverride();
    $request = Request::createFromGlobals();
    $response = $kernel->handle($request);
    $response->send();
    $kernel->terminate($request, $response);
}
run();
```

### 5) Edit .htaccess file on your WordPress root project directory

Put the following rules:

```
DirectoryIndex index.php

<IfModule mod_rewrite.c>
    RewriteEngine On

RewriteCond %{REQUEST_URI}::$1 ^(/.+)/(.*)::\2$
    RewriteRule ^(.*) - [E=BASE:%1]

RewriteCond %{ENV:REDIRECT_STATUS} ^$
    RewriteRule ^index\.php(/(.*)|$) %{ENV:BASE}/$2 [R=301,L]

RewriteCond %{REQUEST_FILENAME} -f [OR]
    RewriteCond %{REQUEST_FILENAME} -d
    RewriteRule .? - [L]

# Rewrite all other queries to the front controller.
    RewriteRule .? %{ENV:BASE}/index.php [L]
</IfModule>

<IfModule !mod_rewrite.c>
    <IfModule mod_alias.c>
        RedirectMatch 302 ^/$ /index.php/
    </IfModule>
</IfModule>
```

You're ready to go.

---

## Use in Symfony

You can call Wordpress table managers in Symfony by calling the following services:

*Service identifier* | *Type*
--- | ---
ekino.wordpress.manager.comment | Wordpress comment manager
ekino.wordpress.manager.comment_meta | Wordpress comment metas manager
ekino.wordpress.manager.link | Wordpress link manager
ekino.wordpress.manager.option | Wordpress option manager
ekino.wordpress.manager.post | Wordpress post manager
ekino.wordpress.manager.post_meta | Wordpress post metas manager
ekino.wordpress.manager.term | Wordpress term manager
ekino.wordpress.manager.term_relationships | Wordpress term relationships manager
ekino.wordpress.manager.term_taxonomy | Wordpress taxonomy manager
ekino.wordpress.manager.user | Wordpress user manager
ekino.wordpress.manager.user_meta | Wordpress user metas manager

So in custom Symfony controllers, you can create / update / delete data in Wordpress database, like that:

```php
# Here an example that sets user #2 as author for post #1
$postManager = $this->get('ekino.wordpress.manager.post');
$userManager = $this->get('ekino.wordpress.manager.user');

$user = $userManager->find(2);

$post = $postManager->find(1);
$post->setAuthor($user);

$postManager->save($post);
```

---

## Use in WordPress

### Call a service from Symfony container

Simply use the `symfony()` method and call your custom service like that:

```php
$service = symfony('my.custom.symfony.service');
```

# Override
## Entities
For every Wordpress entities, you can override the default classes. To do so, just add the following configuration in your `config.yml` (for `Post` entities):
```yaml
ekino_wordpress:
    services:
        post:
            class: MyApp\AppBundle\Entity\Post
```
In order to avoid further troubles when creating a new instance (for example), remember to always use the manager to create a new entity (`$container->get('ekino.wordpress.manager.post')->create()`).

## Managers
You can use your own managers too. To customize it, register yours as services — should be marked as privates — as follow :
```yaml
ekino_wordpress:
    services:
        comment:
            manager: my_custom_comment_service
```
Your manager will now be reachable using the usual command, IE from a controller : `$this->get('ekino.wordpress.manager.comment')`

## Repositories
Implementing your custom repository classes is as simple as follow :
```yaml
ekino_wordpress:
    services:
        comment_meta:
            repository_class: MyApp\MyBundle\Repository\ORM\CustomCommentMetaRepository
```

# Extra
## Enable cross application I18n support

If you already have a wordpress plugin to handle I18n, EkinoWordpressBundle allow to persist language toggle between Symfony and wordpress.
To do so, just grab the cookie name from the wordpress plugin used and provide its name in the configuration as follow :

```yml
ekino_wordpress:
    i18n_cookie_name: pll_language # This value is the one used in "polylang" WP plugin
```

Also, you can implement your own language switcher in Symfony that work cross application. For instance :

```php
<?php

namespace Acme\DemoBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Cookie;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;

class LanguageController extends Controller
{
    /**
     * @param Request $request
     * @param string $locale
     *
     * @return RedirectResponse
     */
    public function toggleLocaleAction(Request $request, $locale)
    {
        $response = new RedirectResponse($this->generateUrl('homepage'));
        $response->headers->setCookie(new Cookie($this->getWpCookieName(), $locale, time() + 31536000, '/', $request->getHost()));

return $response;
    }

/**
     * @return string
     */
    protected function getWpCookieName()
    {
        return $this->container->getParameter('ekino.wordpress.i18n_cookie_name');
    }
}
```

## Handling password protected posts
If you use password protected posts and you have defined your own `COOKIEHASH` constant, you can provide it using the `cookie_hash` parameter in your `config.yml` file.
You will then be able to use the `wp_post_password_required` twig function that behave exactly like `post_password_required` Wordpress function.

## Display Wordpress theme into a Symfony Twig-rendered route

You can display the WordPress header (with administration menu bar if available), sidebar and footer into your Symfony's Twig templates by using the following
Twig functions available in this bundle:

```jinja
{{ wp_get_header() }}
{{ wp_get_sidebar() }}

<div id="main">
    Your Twig code comes here
</div>

{{ wp_get_footer() }}
```

EkinoWordpressBundle

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

EkinoWordpressBundle

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README