Custom parsers

You can create custom advanced parsers if you have the necessary technical skills. Note that this section is intended for developers. We don't provide support for customization tasks, but we do offer services on custom advanced parsers development.

Debug mode

Before getting started with the new parser, we recommend enabling debug mode for the External Importer. To do so, add the following line to your wp-config.php:

define('EXTERNAL_IMPORTER_DEBUG', true);

In this mode, some helpers will be enabled to debug your parser:

• Parsing task quick restart button

• Names of parsers used

• Raw product data

In debug mode, caching of all requests to external websites is enabled. It allows External Importer to skip making many new requests when debugging the parser. You can also check the page returned to the plugin bot.

All temporary cache files are stored in wp-content/uploads/ei-debug/.

After the parser is finished, remember to disable debug mode and manually delete wp-content/uploads/ei-debug/ directory with all temporary files.

Creating a parser

All custom parsers must be stored in wp-content/ei-parsers/. Create this directory if you don't have one. Never directly edit plugin files. Otherwise, you risk losing all changes with the next plugin update.

Let's say we want to create a parser for https://www.example.com.

1. Create a file named ExamplecomAdvanced.php in wp-content/ei-parsers/.

2. Create a class named ExamplecomAdvanced that extends AdvancedParser.

3. Use namespace, enter the domain name in the comments block, as shown in the following example.

<?php
namespace ExternalImporter\application\libs\pextractor\parser\parsers;

/*
 * URI: https://www.example.com
 */

class ExamplecomAdvanced extends AdvancedParser {
    
}

4. Now you need to implement methods to extract product data from the target website:

parseLinks()

parsePagination()

parseTitle()

parseDescription()

parsePrice()

parseOldPrice()

parseImage()

parseImages()

parseManufacturer()

parseInStock()

parseCategoryPath()

parseCurrencyCode()

parseFeatures()

parseReviews()

We recommend studying the implementation of the ready parsers in external-importer/application/libs/pextractor/parser/advanced/parsers/

In most cases, you'll use XPath requests:

$this->xpathScalar($xpath); 
$this->xpathArray($xpath);

If you need to use regular expressions, this is how to access the HTML source:

preg_match($regex, $this->html, $matches);

Advanced parsers have priority when extracting data, but you can implement only a few methods if some data can be extracted through default structured parsers.

Variations

To add support for variations, implement the parseVariations() method as shown below:

public function parseVariations()
{
    $variations = [];

    // Variation 1
    $v = new \ExternalImporter\application\libs\pextractor\parser\Variation;
    $v->attributes = [
        ['name' => 'Size', 'value' => 'S'],
        ['name' => 'Color', 'value' => 'Red'],
    ];
    $v->sku = 'SKU111';
    $v->price = 123.99;
    $v->image = 'https://m.media-amazon.com/images/I/61He0SxcS2L._AC_SX679_.jpg';
    $v->inStock = true;
    $v->availability = 'OutOfStock';
    $v->stockQuantity = 10;
    $v->gtin = 'GTIN1';

    $variations[] = $v;

    // Variation 2
    $v = new \ExternalImporter\application\libs\pextractor\parser\Variation;
    $v->attributes = [
        ['name' => 'Size', 'value' => 'M'],
        ['name' => 'Color', 'value' => 'Blue'],
    ];
    $v->sku = 'SKU222';
    $v->price = 345.99;
    $v->image = 'https://m.media-amazon.com/images/I/713uxj6JdYL._AC_SX679_.jpg';
    $v->inStock = true;
    $v->availability = 'InStock';
    $v->stockQuantity = 20;
    $v->gtin = 'GTIN2';

    $variations[] = $v;

    return $variations;
}

This method returns an array of Variation objects. Only the attributes field is required.