Introduction
WordPress CMS Akeneo Connector – With the help of this connector, you can manage your WordPress website content from Akeneo platform.
Export Akeneo products as blog posts to a WordPress website. Edit your content using the rich text editor, add images, customize font styles, layout, design, etc.
Basic Requirements
- This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x, 6.0.x. and 7.0.x Download Akeneo from here
- This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
- If you want to use this extension on Akeneo EE Serenity mode, please contact us.
- For the Akeneo installation, your Akeneo server should meet these system requirements.
- Compatible with WordPress Advanced Custom Fields (ACF) Akeneo Addon with version 3.0.0.
- Compatible with WordPress ACF Pro Akeneo extension add-on with 1.0.0.
Video Tutorials
Check out the following video tutorials below:
How to get API keys?
How to do module configuration and export products from Akeneo to WordPress CMS?
Features
- Export Products from Akeneo as Posts to WordPress
- Link multiple WordPress Stores
- Export Categories from Akeneo as Post categories in WordPress
- Export Main image as Featured Media
- Can Use fixed values for some fields when Exporting data.
- WordPress CMS Akeneo Connector is compatible with the latest Akeneo version 7.0.x.
- Filter data to be Exported based on Category, family, Completeness, Time conditions, Identifier(SKU), Language, and Currency.
- Compatible with WordPress Advanced Custom Fields (ACF) Akeneo Addon
Installation
Two different types of module installation processes are available for the module.
- Composer Installation
- Manual Installation
Installation using Composer Installation
Before beginning the composer installation
1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository and the installation script.
Akeneo 6 and 7:
{ "scripts": { "post-update-cmd": [ "vendor/webkul/wordpresscmsbundle/src/Webkul/WordpressCmsBundle/install/config.sh COMPOSER=true NO_DOCKER=true" ], "post-install-cmd": [ "vendor/webkul/wordpresscmsbundle/src/Webkul/WordpressCmsBundle/install/config.sh COMPOSER=true NO_DOCKER=true" ], "post-create-project-cmd": [ "vendor/webkul/wordpresscmsbundle/src/Webkul/WordpressCmsBundle/install/config.sh COMPOSER=true NO_DOCKER=true" ] }, "repositories": [{ "type": "composer", "url": "https://akeneorepo.webkul.com/" }] }
For Akeneo <=5.x
{ "scripts": { "post-update-cmd": [ "vendor/webkul/wordpresscmsbundle/composer_install.sh" ], "post-install-cmd": [ "vendor/webkul/wordpresscmsbundle/composer_install.sh" ], "post-create-project-cmd": [ "vendor/webkul/wordpresscmsbundle/composer_install.sh" ] }, "repositories": [{ "type": "composer", "url": "https://akeneorepo.webkul.com/" }] }
3: Use composer to install the extension
composer require webkul/wordpresscmsbundle
4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.
Manual Installation for Version 6.x and 7.x
- After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
- From the PIM directory, run the following command over the NO-DOCKER Instance.
./src/Webkul/WordpressCmsBundle/install/config.sh COMPOSER=false NO_DOCKER=true
- After that run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/WordpressCmsBundle/install/config.sh COMPOSER=false NO_DOCKER=false
Manual Installation for Version 4.0.x to 5.x
Please follow the below steps for installing WordPress Akeneo CMS Connector in Akeneo.
1. Unzip the respective extension zip then merge “src” folder into akeneo project root directory.
2 – Goto config/Bundles.php then add line:
Webkul\WordpressCmsBundle\WordpressCmsBundle::class => ['all' => true]
in return array.
3 – Copy the “config” folder into akeneo project root directory for routing.
4 – Run this command after ssh to your akeneo server by the terminal
php bin/console cache:clear --env=prod && php bin/console wk_wordpress:setup:install --env=prod
5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.
For Akeneo 5
sudo service php-fpm7.4 restart
For Akeneo 4
sudo service php-fpm7.3 restart
Docker Installation Command :
For Akeneo 5
alias docker_php='docker-compose run -u www-data --rm php php'; alias docker_yarn='docker-compose run -u node --rm node yarn'; docker_php bin/console cache:clear --env=prod; docker_php bin/console pim:installer:assets --symlink --clean --env=prod; docker_php bin/console d:s:u --force; docker_yarn run webpack; docker_yarn run update-extensions; docker_yarn run less;
For Akeneo 4
alias docker_php='docker-compose run -u www-data --rm php php'; alias docker_yarn='docker-compose run -u node --rm node yarn'; docker_php bin/console cache:clear --env=prod; docker_php bin/console pim:installer:assets --symlink --clean --env=prod; docker_php bin/console d:s:u --force; docker_yarn run webpack; docker_yarn run less;
Installation for Version 2.x to 3.x
Please follow the below steps for installing WordPress Akeneo CMS Connector in Akeneo.
1. Unzip the respective extension zip then merge the “src” folder into the akeneo project root directory.
2. After that goto app/AppKernel.php then add a line
new Webkul\\WordpressCmsBundle\\WordpressCmsBundle(),
in function registerProjectBundles()
3. Goto app/config/routing.yml then add these lines at top of the file.
wordpresscms: resource: "@WordpressCmsBundle/Resources/config/routing.yml" prefix: /
4. You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.
php bin/console cache:clear --env=prod && php bin/console wk_wordpress:setup:install --env=prod
5. If you are using php-fpm. Then you need to restart the php-fpm services.
sudo service php-fpm7.2 restart
Common Issues After Installation
It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:
-
- Webpack Installation: If you get the below error
It means that webpack is not installed in your system. Run the following commandnpm install --save-prod webpack npm install
- Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
- Clear your browser cache.
- Webpack Installation: If you get the below error
Uninstall Module: For Akeneo 6 and 7
- From the PIM directory, run the command below over the NO-DOCKER Instance.
./src/Webkul/WordpressCmsBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
- Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/WordpressCmsBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false
Enable HTTP Authorization on WordPress
Some time HTTP authorization does not work in WordPress. You can solve it by .htaccess file modification.
WordPress creates a block that looks something like this in .htaccess file.
For it, you have to add this line to this file.
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization}]
After adding this line you can see the .htaccess file like this.
Creating WordPress API Credentials
Before you begin, you need to install Application Password plugin in your WordPress. After that follow the steps below:-
- Login to WordPress admin panel then go to Plugins section.
- Search Application Passwords after that install and activate the plugin.
- Then, go to Users>Your Profile and find Application Passwords section.
- Enter any name for your new application password then click Add New.
- Once the Add New button is clicked, your new application password will appear on the screen.
Module Configuration
Once you have installed WordPress CMS Akeneo Connector in Akeneo, login to Akeneo admin panel. Then, go to WordPress CMS Connector>Credentials after that enter the following:
Credentials
Site URL – Enter your WordPress website URL here.
Username – Enter your WordPress username here.
Application Password – Enter the API password that you have just created in the previous section.
Mapping
Now, you need to do the mapping between WordPress post fields and Akeneo attributes. Mapping of these attributes allows you export the information correctly from Akeneo to WordPress.
Title – Select the Akeneo attribute which will be used as the post title.
Content – Select the Akeneo attribute which will be the content.
Excerpt – Select which Akeneo attribute will be used as the excerpt for posts.
Password – Select the Akeneo attribute which will be used for mapping password for viewing a post. A will password will protect access to the content and excerpt.
Comment Status – Select the Akeneo attribute which will be used for managing comment permission on a post. Whether or not comments are open on the blog post.
Ping Status – Select the Akeneo attribute for managing ping status for blog posts. Whether or not the post can be pinged.
Format – If your WordPress theme supports post formats, you can map this information from Akeneo using attributes. Find more information here – https://en.support.wordpress.com/post-formats/
Sticky – Select the Akeneo attribute for managing sticky post information. Whether or not the post should be treated as sticky.
Fixed Attribute Value
If you want to use some fixed values for all the exported posts, you can mention that in the right column.
Featured Image
For mapping, the featured image of a post, and the main image of a product will be used from Akeneo.
Creating Post
In WooCommerce CMS Akeneo Connector, the Akeneo products are exported as posts on WordPress blog site. So once you have configured the attributes and family for the blog posts, now to create a new product (blog post), go to Products>Create.
Select the Product type option.
Enter all the product information for the blog post such as title, snippet, description, etc.
Upload the featured image for the blog post, make sure you have selected the correct Attribute used as the main picture in Families settings. Enter the main body content in the Description text area. You can also use HTML code formatting.
Mention all the other post information required such as Sticky Post, Enable Comments, and Ping status
Export Job
Once you have your post data ready, you can now move on to exporting process. Go to Exports>Create Export Profile. Then, enter any code, and label and select a job:-
Three types of export jobs will be available to you:
- Export All Job – It will export all the products including the categories.
- Product Only Export – It will only export products to WordPress.
- Categories Only Export – It will only export categories to WordPress.
After you have created the export profile, go to Content. From here, you can select your channel, locale, and attributes.
If you don’t want to export all the products, you can use various built-in filters of Akeneo:
- Family – Export products belonging to a family.
- Status – Export products which are either enabled or disabled.
- Completeness – Export products according to their information completion.
- Time Condition – Export products based on their date modified condition.
- Category – Export products belonging to specific categories.
- Identifier – Export product using SKU values separated by commas.
Credentials
In case you are managing multiple WordPress websites, you can provide different credentials for each export job. Else, you can leave the credentials fields blank.
Once you have saved your export profile information, click Export Now button and wait for the execution process to get over.
WordPress Frontend
Once the export process is completed, your exported posts will be visible on the WordPress website.
After exporting once, update the post again, and then export it to ensure the post displays the updated data, as illustrated in the screenshot, below.
Front-end:
Support
So, that was much about the User Guide of WordPress CMS Akeneo Connector for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.
Please explore our Akeneo Development Services and Quality Akeneo Extensions.
Current Product Version - Akeneo 2 to 5 || 3.0.0, Akeneo 6 || 4.1.0 and Akeneo 7 || 5.2.1
Supported Framework Version - WordPress 6.2 | Akeneo 2.x.x & 3.x.x & 4.x.x, 5.x.x & 6.x.x and 7.x.x
Be the first to comment.