Suggestions for documentation Custom Modules

[xberg]

Hi,
I followed your documentation carefully and was successful in creating custom modules but here 2 suggestions:

• your folder structure has changed since you wrote the docs. The modules folder has changed location
• you don't really explain the full steps on how to create a parent custom module: I tried and failed. So I went with a child of post.
• it was not obvious for me that you had to refresh the cache after creating a custom module.

[kminh]

Thank you @xberg . We will discuss more about this when I start working on enhancements for the module API.

[orditeck]

@kminh @OddOneOut,

in the docs, it says:

You might ask: “If I add more modules, what will happen when this plugin gets updated?” No worry, you have the option to set a custom module directory that will take precedence over the default module directory. Simply speaking, this plugin will look for modules in the custom directory first, and when it can not find the requested module file, it will look for modules in the default one, in the exact same way described above.

Where do I have the option to set a custom module directory that will take precedence over the default module directory?

Thanks.

[orditeck]

Looking in the plugin's code, I ended up adding this in my functions.php:

// Specify where Better WordPress Google XML Sitemaps has to go to find custom modules
add_filter('bwp_gxs_module_dir', function(){
    return get_stylesheet_directory() . '/framework/bwp_gxs';
});

// Add our custom WordPress Google XML Sitemaps modules
add_action('bwp_gxs_modules_built', function(){
    global $bwp_gxs;
    $bwp_gxs->add_module('post', 'programs');
});

In framework/bwp_gxs, I created a file named post_programs.php.

Here's my post_programs.php file:

<?php

class BWP_GXS_MODULE_post_programs extends BWP_GXS_MODULE
{
    protected function generate_data()
    {
        $api = new \Path\To\My\API;
        $programs = $api->get('programs');

        if($programs && $programs->data) {
            foreach($programs->data as $program) {
                $this->data[] = [
                    'location'  => $program->slug,
                    'lastmod'   => date('Y-m-01'),
                    'freq'      => 'monthly'
                ];
            }
            return true;
        } else {
            return false;
        }
    }
}

Hope it can help someone!