How to use a template for my pod from a php file?

[WebDesignWorx]

I want to edit my template files in the IDE of my choice and load the files to a plugin.
I have this structure:
wp-content/

└── plugins/
    └── pods-cust-tpls/
        ├── tpl/
        │   └── single_view/
        │      ├── single_view.php
        │      ├── css.css
        │      └── js.js
        │   └── loop_view/
        │      ├── loop_view.php
        │      ├── css.css
        │      └── js.js
        └── pods-cust-tpls.php

I tried with a code like this:

// Hook into WordPress initialization
add_action('init', 'initialize_pods_templates');

function initialize_pods_templates() {
    if (function_exists('pods_api')) {
        $pods_api = pods_api();

        // Define your template files and names
        $templates = [
            'single_view' => __DIR__ . '/tpl/single_view/single_view.php',
            'cust_loop_view' => __DIR__ . '/tpl/loop_view/loop_view.php',
        ];

        foreach ($templates as $name => $file_path) {
            if (file_exists($file_path)) {
             trigger_error('file found');
                $template_content = file_get_contents($file_path);

                // Check if the template already exists
                $existing_template = $pods_api->load_template(['name' => $name]);

                if (!$existing_template) {
                    // Create the Pods template
                    $template_data = [
                        'name' => $name,
                        'content' => $template_content,
                        'type' => strpos($name, 'loop') !== false ? 'loop' : 'single',
                    ];

                    $pods_api->save_template($template_data);
                }
            }
        }
    }
}

But I am missing something.
The template is listed in Pods/Teplates (though the code isn't shown here and I actually don't need to edit from here)
But I can't select the template when I go to
Pods/Edit Pods/My Pod/Automatic Templates

Any help would be very much appreciated.

[callmeahmedr]

Hi there,

You’re on the right track with your approach, but there may be a few details missing or needing adjustment:

1. Verify Template Creation
2. Verify Template Types
3. Ensure Proper Hooks
4. Check for Template Overwriting
5. Update Template Content

Here's the refined code

add_action('init', 'initialize_pods_templates');

function initialize_pods_templates() {
    if (function_exists('pods_api')) {
        $pods_api = pods_api();

        $templates = [
            'single_view' => __DIR__ . '/tpl/single_view/single_view.php',
            'cust_loop_view' => __DIR__ . '/tpl/loop_view/loop_view.php',
        ];

        foreach ($templates as $name => $file_path) {
            if (file_exists($file_path)) {
                $template_content = file_get_contents($file_path);

                $existing_template = $pods_api->load_template(['name' => $name]);

                if (!$existing_template) {
                    $template_data = [
                        'name' => $name,
                        'content' => $template_content,
                        'type' => strpos($name, 'loop') !== false ? 'loop' : 'single',
                    ];

                    $result = $pods_api->save_template($template_data);
                    if ($result) {
                        error_log("Template '$name' created successfully.");
                    } else {
                        error_log("Failed to create template '$name'.");
                    }
                } else {
                    error_log("Template '$name' already exists.");
                }
            } else {
                error_log("File not found: $file_path");
            }
        }
    }
}

If you continue facing issues, providing additional details on any error messages or unexpected behavior can help in diagnosing the problem further. Feel free to share any logs or additional code snippets that might shed light on the issue.

[WebDesignWorx]

Hello, thank you.

After applying your refined code my log says
Template '$name' created successfully.
and then
Template '$name' already exists

I also see the template in the list of templates in wp-admin>Pods-Admin>Pod Templates.
However, when I go to Edit Pods and select any pod I can't select the template in the select dop-down.

I handled my issue temporarily by hardcoding the path to my pod php file into the code-editor of the template in the admin backend. Maybe there will be a better way of linking files in a future iteration of pods.
Thank you for the effort.

[callmeahmedr]

Sorry it took me a while to get back to you! It sounds like the templates are being successfully created, but they aren't being correctly registered or recognized within the Pods admin interface

Looking at the log I think issue is that the templates may not be properly linked or the template type might not match what Pods expects for specific use cases.

Here's the updated code

/**
 * Automatically initialize and register Pods templates from plugin directory.
 */
add_action('pods_api_init', 'initialize_pods_templates');

function initialize_pods_templates() {
    if (function_exists('pods_api')) {
        $pods_api = pods_api();

        // Define your template files and their names
        $templates = [
            'single_view' => [
                'file' => __DIR__ . '/tpl/single_view/single_view.php',
                'label' => 'Single View Template',
                'type' => 'single',
            ],
            'cust_loop_view' => [
                'file' => __DIR__ . '/tpl/loop_view/loop_view.php',
                'label' => 'Custom Loop View Template',
                'type' => 'loop',
            ],
        ];

        foreach ($templates as $name => $details) {
            if (file_exists($details['file'])) {
                $template_content = file_get_contents($details['file']);

                // Check if the template already exists in Pods
                $existing_template = $pods_api->load_template(['name' => $name]);

                if (!$existing_template) {
                    // Create a new Pods template
                    $template_data = [
                        'name' => $name,
                        'label' => $details['label'],
                        'content' => $template_content,
                        'type' => $details['type'], // Ensure correct template type
                    ];

                    $result = $pods_api->save_template($template_data);

                    if (is_wp_error($result)) {
                        notify_admin("Failed to create Pods template: " . $name);
                    } else {
                        notify_admin("Template '{$name}' created successfully.");
                    }
                } else {
                    // Update the existing template if needed
                    $template_data = array_merge($existing_template, [
                        'label' => $details['label'],
                        'content' => $template_content,
                    ]);

                    $result = $pods_api->save_template($template_data);

                    if (is_wp_error($result)) {
                        notify_admin("Failed to update Pods template: " . $name);
                    } else {
                        notify_admin("Template '{$name}' already exists and was updated.");
                    }
                }
            } else {
                // Notify admin if the file is not found
                notify_admin("Pods template file not found: " . $details['file']);
            }
        }
    } else {
        // Notify admin if Pods API is not available
        notify_admin("Pods API is not available.");
    }
}

/**
 * Send an email notification to the site admin.
 *
 * @param string $message The message to send.
 */
function notify_admin($message) {
    $admin_email = get_option('admin_email');
    $subject = 'Pods Template Management Notification';
    wp_mail($admin_email, $subject, $message);
}

This code now adds Template Labels along with Type Matching as well.

Hope this fixes the issue

[WebDesignWorx]

Thank you, this was the missing piece!

I have rewritten the code to automatically register new templates when I upload them to the directory via FTP.

If anyone wants to do it too, this is the way my structure looks (I am using Timber/Twig for templates but it will work the same with simple PHP templates).

wp-content/
└── plugins/
    └── pods/
    └── pods-cust/
        ├── tpl/
        │   ├── mask_overview/
        │   │   ├── css.css
        │   │   ├── mask_loop.twig
        │   │   └── tpl.php
        │   ├── mask_single/
        │   │   ├── css.css
        │   │   ├── mask_single.twig
        │   │   └── tpl.php
        │   ├── new_loop_view/
        │   │   ├── css.css
        │   │   ├── mask_loop.twig
        │   │   └── tpl.php
        │   └── new_single_view/
        │       ├── css.css
        │       ├── mask_single.twig
        │       └── tpl.php
        └── pods-cust.php
        ```
        
        
        I have a function in my dods-cust.php that reads templates from the "tpl" directory.
        The naming convention is that a template's directory name needs to contain either `loop` or `single` otherwise it will be dismissed. Also, the template directory needs to contain a `tpl.php`.
        
        ```
        function pods_cust_get_templates_from_dir() {
    $tpl_dir = __DIR__ . '/tpl/';
    $templates = [];

    foreach (glob($tpl_dir . '*/tpl.php') as $tpl_path) {
        $dir = basename(dirname($tpl_path));
        $name = ucfirst(str_replace('_', ' ', $dir));
        $type = strpos($dir, 'single') !== false ? 'single' : (strpos($dir, 'loop') !== false ? 'loop' : null);

        if ($type) {
            $templates[$dir] = [
                'name' => $name, 
                'type' => $type,
                'path' => $tpl_path,
            ];
        }
    }

    return $templates;
}

The above function for gathering templates will be used with this function:

function pods_cust_initialize_pods_templates() {
    if (function_exists('pods_api')) {
        $pods_api = pods_api();
        $templates = pods_cust_get_templates_from_dir();
        foreach ($templates as $dir => $details) {
                // Check if the template already exists in Pods
                $existing_template = $pods_api->load_template(['name' => $details['name']]);

                if ($existing_template) {
                    continue;                    
                } else {
                    error_log("Template '{$dir}/{$details['name']}' already exists.");
                    // Pods template doesn't exist yet. Create a new template.
                    // Get the relative path
                    $relativePath = str_replace(WP_CONTENT_DIR, '', $details['path']);
                    // Construct the final content
                    // this strings goes into the POD Templates code editor when the template is selected
                    $template_content = "<?php include WP_CONTENT_DIR . '{$relativePath}'; ?>";
                    $template_data = [
                        'name' => $details['name'],
                        'type' => $details['type'], // Ensure correct template type
                        'code' => $template_content,
                    ];
                    $result = $pods_api->save_template($template_data);

                    if (is_wp_error($result)) {
                        error_log("Failed to create Pods template: {$dir}/{$details['name']}");
                    } else {
                        error_log("Template '{$dir}/{$details['name']}' created successfully.");
                    }
                } 
        }
    } else {
        // Notify admin if Pods API is not available
        error_log("Pods API is not available.");
    }
}

It really works like a charm, thanks.

Oh, by the way, I only write an include to the file-path into the code that will be shown in the pods code editor.
It's because I work in my IDE on the template and upload them via FTP.

Thank you for the help.
It's still a workaround and I hope Pods will have a better solution to in the future to include php files directly rather than via a code/content.

[callmeahmedr]

I’m glad we were able to solve your problem today!

Happy coding!