Custom fields from calculator plugin

Hey @alexinwp,

Were you able to solve your issue with the last shared code snippet?

@alexinwp that’s unfortunate, sorry. 🙁

I think I found my error however (or at least 1 error). In this block of code:

   if ( ! $item instanceof WC_Order_Item ) {
        return;
    }

I believe I’m supposed to use $item['item'] instead of just $item. A previous code adjustment you made (here) should even confirm this. So it is supposed to be:

if ( ! $item['item'] instanceof WC_Order_Item ) {
     return;
 }

So try this code snippet instead:

add_action( 'wpo_wcpdf_after_item_meta', 'wpo_wcpdf_ccb_calculator_details', 10, 3 );

function wpo_wcpdf_ccb_calculator_details( $template_type, $item, $order ) {
    if ( ! $item['item'] instanceof WC_Order_Item ) {
        return;
    }

    $ccb_calculator = $item->get_meta( 'ccb_calculator', true, 'edit' );

    if (
        ! is_array( $ccb_calculator )
        || empty( $ccb_calculator['calc_data'] )
        || ! is_array( $ccb_calculator['calc_data'] )
    ) {
        return;
    }

    echo '<div class="product-details">';
    echo '<strong>Details:</strong>';
    echo '<ul>';

    foreach ( $ccb_calculator['calc_data'] as $option ) {
        $label = $option['label'] ?? '';
        $value = $option['value'] ?? '';

        if ( $label === '' && $value === '' ) {
            continue;
        }

        echo '<li>';
        echo esc_html( $label );

        if ( $label !== '' && $value !== '' ) {
            echo ': ';
        }

        echo esc_html( $value );
        echo '</li>';
    }

    echo '</ul>';
    echo '</div>';
}

If the correction above does not work, here are my troubleshooting steps…

• Could you tell me how much info is being displayed?
  For example: Does the text “Details:” appear?
  This helps me find the conditions I entered in the code snippet that is failing.

• Under this line of code:

    $ccb_calculator = $item->get_meta( 'ccb_calculator', true, 'edit' );

Could you add this?

var_dump( $ccb_calculator );

Save the snippet, then check the PDF output to see if something gets printed and what the printed value is.

@alexinwp,

Could this be because we’re not explicitly naming each option contained in calc_data that we want to display ?

I am not quite sure of that. The “Details:” text is outside and before the calc_data loop. Since the “Details:” text is not even visible, then I am more immediately inclined to think one of these two conditions is failing.

if ( ! $item['item'] instanceof WC_Order_Item ) {
     return;
 }

OR

  if (
        ! is_array( $ccb_calculator )
        || empty( $ccb_calculator['calc_data'] )
        || ! is_array( $ccb_calculator['calc_data'] )
   ) {
        return;
   }

Hopefully this is not too advanced/complex:

Were you able to perform this troubleshooting step? I forgot to add one step at the end:

• Under this line of code:

    $ccb_calculator = $item->get_meta( 'ccb_calculator', true, 'edit' );

Could you add this?

var_dump( 'The custom field: ', $ccb_calculator );

Finally, temporarily output your PDF as HTML in order to see the result of the var_dump( $ccb_calculator ) function.

Path: WooCommerce > PDF Invoices > Advanced > Settings > Output to HTML.

The data you would be looking for is anything that appears after the “The custom field: ” text.

If there is no result at all, no printed text from the snippet in the item meta data area, then the 1st condition may be the condition that is failing. If “The custom field: ” text appears, then the 1st condition is not failing.

@alexinwp,

Your $item to $item['item'] correction helped a lot. The diagnostic step was successful thanks to that. We will not need HTML mode anymore. 🙂

The fact that you got a big mess of the data printed after the correction means that the 2nd condition was what was failing, as I had missed another incorrect usage of $item, on this line:

$ccb_calculator = $item->get_meta( 'ccb_calculator', true, 'edit' );

This caused a fatal error because I was applying the get_meta() function on the $item array object. We want that function on the WooCommerce order item object, so on $item['item'].

This is the updated code snippet, with the above correction applied. I removed the var_dump()function, so you should not get an ugly printed mess anymore and the table items will return:

add_action( 'wpo_wcpdf_after_item_meta', 'wpo_wcpdf_ccb_calculator_details', 10, 3 );

function wpo_wcpdf_ccb_calculator_details( $template_type, $item, $order ) {
    if ( ! $item['item'] instanceof WC_Order_Item ) {
        return;
    }

    $ccb_calculator = $item['item']->get_meta( 'ccb_calculator', true, 'edit' );

    if (
        ! is_array( $ccb_calculator )
        || empty( $ccb_calculator['calc_data'] )
        || ! is_array( $ccb_calculator['calc_data'] )
    ) {
        return;
    }

    echo '<div class="product-details">';
    echo '<strong>Details:</strong>';
    echo '<ul>';

    foreach ( $ccb_calculator['calc_data'] as $option ) {
        $label = $option['label'] ?? '';
        $value = $option['value'] ?? '';

        if ( $label === '' && $value === '' ) {
            continue;
        }

        echo '<li>';
        echo esc_html( $label );

        if ( $label !== '' && $value !== '' ) {
            echo ': ';
        }

        echo esc_html( $value );
        echo '</li>';
    }

    echo '</ul>';
    echo '</div>';
}

• This reply was modified 3 weeks, 1 day ago by Darren Peyou. Reason: additional info