WordPress ACF Akeneo Documentation

WordPress ACF Akeneo Extension facilitates the user adding custom fields on the WordPress end and mapping them to Akeneo PIM. Which will help in creating CMS content over WordPress and exporting it on Akeneo.

Users can create multiple custom field attribute types based on default types on WordPress and WooCommerce end.

Note: The WordPress ACF Akeneo extension is an add-on for the WordPress CMS Akeneo connector. To use the extension, you must have installed the WordPress CMS Akeneo connector.

If you want to use the module for WooCommerce products, then you must install the WooCommerce Akeneo Connector

• This module works with Akeneo 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.

• The module is compatible with WordPress CMS Akeneo Connector with version 5.2.1 
• Module compatible with WooCommerce Akeneo Connector with version 5.3.1 
• Also this module compatible with Akeneo WooCommerce WPML Integration with version 5.1.1 
• Mapped Advanced Custom Fields and exported product attribute value.
• This attribute type does not support the Image and File type
• Map Already created Advanced Custom Fields in Akeneo.
• Export Product attributes ACF value from Akeneo to WooCommerce / WordPress CMS.
• Support ACF field types [ Text, Text Area, Number, Range, Email, URL Password, Wysiwyg Editor, oEmbed, Select, Checkbox, Radio Button, Button Group, True / False, date picker] for WooCommerce.
• Support ACF field types [ Text, Text Area, Number, Range, Email, URL Password, Wysiwyg Editor, oEmbed, Select, Checkbox, Radio Button, Button Group, True / False, date picker, File Image] for WordPress CMS.
• Users can export category as custom taxonomy.
• Users can export the choices via label and code.
• Users can export product custom post types as well.

Note – You can also use ACF pro features with the help of WordPress ACF Pro Akeneo extension.

Two different types of module installation processes are available for the module.

1. Composer Installation
2. Manual Installation

Composer Installation

Read this blog: How to install Webkul Akeneo Connector via Composer? before starting the installation via composer.

1- GET the Access Keys Raise a ticket.

2- Add our repository and installation script to your Akeneo composer.json.

Akeneo 6 and 7:

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/acf/src/Webkul/ACFFieldBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/acf/src/Webkul/ACFFieldBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/acf/src/Webkul/ACFFieldBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3 – Install the extension using Composer.

composer require webkul/acf

4- Fill in the authentication.

5- Success message.

6- Clear the browser cache.

• Unzip the respective extension zip and then merge the “src” folder into the Akeneo project.

• Run the below command over the NO-DOCKER Instance from the PIM directory.

./src/Webkul/ACFFieldBundle/install/config.sh COMPOSER=false NO_DOCKER=true

• Run the below command over the DOCKER Instance from the PIM directory.

./src/Webkul/ACFFieldBundle/install/config.sh COMPOSER=false NO_DOCKER=false

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 command

npm 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.

• Run the below command over the NO-DOCKER Instance from the PIM directory.

./src/Webkul/ACFFieldBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

• Run the below command over the DOCKER Instance from the PIM directory.

./src/Webkul/ACFFieldBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

The admin can easily generate API keys from the WordPress Admin backend. For this, the admin will navigate to WooCommerce -> Settings as per the below image.

After that navigate to API -> Keys/Apps -> Add Key as per the below image.

The admin will be redirected to the Key Details page when the admin clicks on the Add Key button.

Here, the admin will:

• Add the Description.
• Select the WordPress admin User to generate the key.
• For this REST API key, choose Read/Write Permission as the level of access.

After entering all the details, the admin will click the “Generate API Key” button. This will generate REST API keys for the selected user as per the below image.

Before you begin, you need to install the Application Password plugin in your WordPress. After that follow the steps below:-

1. Login to the WordPress admin panel then go to the Plugins section.
2. Search Application Passwords after that install and activate the plugin.
3. Then, go to Users>Your Profile and find the Application Passwords section.

1. Enter any name for your new application password then click Add New.
2. Once the Add New button is clicked, your new application password will appear on the screen.

After the successful integration, users can create custom fields in WordPress. Navigate to ACF > Field groups firstly create a field group to add custom fields it. Click on Add New and enter details.

Custom Field Creation

Once the field group will create admin can create advanced custom fields in that group.

Click on add field option and create a new custom field.

dmin can create multiple advanced custom fields as per their requirements.

In the context of Advanced Custom Fields (ACF), location rules are used to determine where and when custom fields should be displayed within WordPress. ACF provides a flexible and intuitive interface for creating custom fields and assigning them to specific locations on your website.

Here are some commonly used location rules in ACF:

Post Types:
You can choose to display your custom fields on specific post types, such as posts, pages, or custom post types created by plugins or themes.

WooCommerce:

Post Type: In WooCommerce, products are custom post types. You can set the location rule to display ACF fields on the “product” post type.

Note: If you are using WooCommerce, then create the role for product types. For WordPress, you can use post type.

In the group setting, after activating the API and enabling Show in REST API, you are able to see the custom field to Akeneo, whatever you create the custom field in WordPress.

Field Group Creation

After clicking on the Add New button a new page will open.

General Settings

In the general settings tab, the admin needs to fill in field details like-

Title – Add the field group title name.

Type– Choose the field type as basic

WordPress – Text, Text Area, Number, Range, Email, URL Password, Wysiwyg Editor, oEmbed, Select, Checkbox, Radio Button, Button Group, True / False, date picker, File, and Image.

WooCommerce – Text, Text Area, Number, Range, Email, URL Password, Wysiwyg Editor, oEmbed, Select, Checkbox, Radio Button, Button Group, True / False, date picker.

Label– This is the name that will appear on the EDIT page

Name– Enter any field name.

Default Value– Appears when creating a new post.

Validation

In this section, the admin needs to validate the field group and set the word limit if they want to.

Presentation

Instruction– Instructions for authors. Shown when submitting data.

Placeholder Text– Appears within the input.

Prepend– Appears before the input.

Append– Appears after the input.

Wrapper Attributes– Add the details in wrapper attributes like width, class, and ID.

Conditional Logic

If the admin wants to enable the conditional logic then they can enable the toggle button. After that few options will open to create the condition.

For adding the field admin needs to fill in the same parameters which they already created at the time of field group creation.

After installing the module in Akeneo, you need to set up the WooCommerce API keys in Akeneo. For this, log into Akeneo then navigate to WooCommerce Connector>Add Credentials.

Then you have to enter the following details:

• Shop URL
• Consumer Key
• Consumer Secret

Then click the “Save” button. Credentials will save in the Akeneo PIM.

Once the WooCommerce connector is added, the user can check the ACF field section and map the attribute value on exported custom fields.

Users can add these created custom fields in product and post creation.

The user can run the export job from Akeneo PIM for WooCommerce and WordPress separately. Navigate to Export > Create Export Profile. Then, enter any code, and label and select a job:-

For WooCommerce

Once you click on the save button profile will create and you need to enter details. Click on content and you can select your channel, locale, and attributes.

If you want to select any specific attribute then the user can drag and drop in the attribute list.

Once you have saved your export profile information, click the Export Now button and wait for the execution process to get over.

Product Data Export on WooCommerce

Users can export custom field attributes from Akeneo to WooCommerce. After the attribute export job user can add any custom field data to a product.

Example: Email field mapped in the product after successful export it will display on WooCommerce end.

Export product via CSV-

Once the data is exported it will show the completed message in the export tab.

Product on WooCommerce end-

Here, the user can check the exported custom field data in the product.

Once you have installed WordPress CMS Akeneo Connector in Akeneo, log in to the Akeneo admin panel. Then, go to WordPress CMS Connector>Credentials after that enter the following:

Credentials WordPress

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. 

The user can export specific custom fields on the WordPress end. 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.

Once WordPress connects with Akeneo, users can check all created custom fields in the ACF field tab.

To map these custom fields with attributes, the user needs to navigate into each field and map the value on it.

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 that 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.

Now click on the save button and export the job, it will reflect in the process tracker.

Post Data Export on WordPress

Similarly, users can export custom field attributes data from Akeneo to WordPress. After the attribute export job user can add any custom field data to a post.

Example: Media custom field mapped in the post after successful export it will display on WordPress end.

Once the data is exported it will show the completed message in the export tab.

Exported Post on WordPress End-

Support

That’s all about the WordPress ACF Akeneo extension, 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.