Woocommerce how to get meta value from the order object

Question

I'm trying to get a custom meta data field from wc_order. I have to clarify that I'm not a pro in php and I have tried many ways to get field, with:

get_meta()
get_meta_data()
get_post_meta( $order_id )
and so on...

But none of them have worked. I have this order object:

I'm trying to get the following user_instagram value: order > meta_data[3] > current_data > value

Does someone know a way to get it?

Edit

I'm trying to add lty_user_instagram field. This is the function in charge of doing it.

public static function create_ticket_on_placing_order( $order_id, $product_id = false ) {

  if ( get_post_meta( $order_id , 'lty_lottery_ticket_created_once' , true ) ) {
    return ;
  }

  $order = wc_get_order( $order_id ) ;

  if ( ! is_object( $order ) ) {
    return ;
  }

  $user_id = $order->get_user_id() ;
  if ( ! $user_id ) {
    return ;
  }

  $user = get_user_by( 'ID' , $user_id ) ;

  if ( ! $user->exists() ) {
    return ;
  }

  $currency   = $order->get_currency() ;
  $ip_address = ! empty( $order->get_customer_ip_address() ) ? $order->get_customer_ip_address() : lty_get_ip_address() ;

  $ticket_ids = array() ;

  foreach ( $order->get_items() as $item ) {
    $product = $item->get_product() ;
    if ( ! is_object( $product ) || 'lottery' != $product->get_type() || ! $product->has_lottery_status( 'lty_lottery_started' ) ) {
      continue ;
    }

    // Validate product id.
    if ( $product_id && $product->get_id() != $product_id ) {
      continue ;
    }

    $answer          = '' ;
    $answers         = array() ;
    $is_valid_answer = 'no' ;

    if ( isset( $item[ 'lty_lottery_answers' ][ 0 ] ) ) {
      $question_answers = $product->get_answers() ;
      if ( array_key_exists( $item[ 'lty_lottery_answers' ][ 0 ] , $question_answers ) ) {
        $answer  = $question_answers[ $item[ 'lty_lottery_answers' ][ 0 ] ][ 'label' ] ;
        $answers = array(
          'label' => $question_answers[ $item[ 'lty_lottery_answers' ][ 0 ] ][ 'label' ] ,
          'key'   => $item[ 'lty_lottery' ][ 'answers' ] ,
          'valid' => $question_answers[ $item[ 'lty_lottery_answers' ][ 0 ] ][ 'valid' ]
            ) ;

        $is_valid_answer = $question_answers[ $item[ 'lty_lottery_answers' ][ 0 ] ][ 'valid' ] ;
      }
    }

    $args = array(
      'lty_user_id'      => $user->ID ,
      'lty_user_instagram' => "Here is where I want to ser order's user_instagram" ,
      'lty_product_id'   => $product->get_id() ,
      'lty_amount'       => $product->get_price() ,
      'lty_user_name'    => $user->user_login ,
      'lty_user_email'   => $user->user_email ,
      'lty_currency'     => $currency ,
      'lty_order_id'     => $order_id ,
      'lty_answer'       => $answer ,
      'lty_answers'      => $answers ,
      'lty_valid_answer' => $is_valid_answer ,
      'lty_ip_address'   => $ip_address ,
        ) ;
            
    $ticket_numbers = $product->get_ticket_numbers($item);
    if ( ! lty_check_is_array( $ticket_numbers ) ) {
      continue ;
    }

    foreach ( $ticket_numbers as $ticket_number ) {

      $args[ 'lty_ticket_number' ] = $ticket_number ;
      $ticket_ids[]                = lty_create_new_lottery_ticket( $args , array( 'post_parent' => $product->get_lottery_id() , 'post_status' => 'lty_ticket_pending' ) ) ;
    }
            
    if ( ! $product->is_manual_ticket() ) {
      // Update order item meta for automatic type.
      $item->add_meta_data( '_lty_lottery_tickets' , $ticket_numbers ) ;
      $item->add_meta_data( esc_html__( 'Ticket Number( s )' , 'lottery-for-woocommerce' ) , implode( ' , ' , $ticket_numbers ) ) ;
      $item->save() ;
    }

    //Unset metas on placing order.
    self::unset_metas_on_placing_order( $product , $order , $ticket_numbers ) ;
  }

  if ( lty_check_is_array( $ticket_ids ) ) {
    // Update custom order meta for ticket ids.
    update_post_meta( $order_id , 'lty_ticket_ids_in_order' , $ticket_ids ) ;
    update_post_meta( $order_id , 'lty_lottery_ticket_created_once' , '1' ) ;
  }
}

The plugin I'm trying to edit is Lottery for Woocommerce by FantasticPlugins (class-lty-order-handler.php)

When you say *"This is what I get on each case when I try to get $order metadata."*, what's the code you're trying? The one with `$args` doesn't even work. Provide your code i want to see the code with which you get the "data". — Ruvee, Sep 08 '21 at 19:21
Also include the name of the plugin you use to store the metadata. — Ruvee, Sep 08 '21 at 19:22
Please edit your question. Currently, your question is not reproducible, you're claiming that you're getting a result using a code snippet that doesn't even run because it's incorrect. You don't provide the name of the plugin you're using to store your metadata either. — Ruvee, Sep 08 '21 at 19:43
I have edited question, let me know if there's something else I should add as info — Ezequiel S. Sandoval, Sep 08 '21 at 20:41

Ruvee · Accepted Answer · 2021-09-08T19:49:18.477

8

The following solutions have been fully tested on wordpress 5.8 and woocommerce 5+.

They're recommended, if you use update_post_meta to store your metadata as part of the order object.

Please keep in mind, if you're using third party plugins that store the metadata for you, then you may encounter discrepancies.

You could use the following ways to get your metadata:

$order_id = 12345;

$order = wc_get_order($order_id);

1- using $order->get_meta():

echo "<pre>";
print_r($order->get_meta('user_instagram'));
echo "</pre>";

2- using get_post_meta():

echo "<pre>";
echo get_post_meta($order->get_id(), 'user_instagram', true);
echo "</pre>";

3-using get_post_meta($order_id):

echo "<pre>";
print_r(get_post_meta($order_id)['user_instagram'][0]);
echo "</pre>";

4- using $order->get_meta_data():

echo "<pre>";
foreach ($order->get_meta_data() as $object) {
  $object_array = array_values((array)$object);
  foreach ($object_array as $object_item) {
    if ('user_instagram' == $object_item['key']) {
      print_r($object_item['value']);
      break;
    }
  }
}
echo "</pre>";

edited Sep 08 '21 at 19:49

answered Sep 08 '21 at 06:58

Ruvee

8,611
4
18
44

I get my data dump when I `print_r($order)`, metadata prop is inside `$order` but let me try with you proposals and I'll let you know if it some works – Ezequiel S. Sandoval Sep 08 '21 at 17:20
There's one particular thing and it is that `get_post_meta` doesn't get back all meta fields but this is because **user_instagram** is inserted into database after this function is executed... the only part where y can get it from is from `$order` object. – Ezequiel S. Sandoval Sep 08 '21 at 18:11
2

1- How do you save `user_instagram` as part of the order object to the data base? 2-`get_post_meta` is using order object. `$order->get_meta_data()`. I've tested all three of the functions above and they all work on my end. – Ruvee Sep 08 '21 at 18:15
`user_instagram` is a custom field in the checkout form, it's handled by a plugin. But when I get the **order** with `wc_get_order` the dump is the one that you see above and it includes the user instagram on it, but I'm not able to get that field yet. When I use `$order->get_meta_data()` it returns only one meta data field, the one with the **key** `is_vat_exempt`. If i use `get_post_meta` it gets the last metadata field I mention and another 20 keys. Will edit my question to show whats returned on each case – Ezequiel S. Sandoval Sep 08 '21 at 18:23
You can check **Edit 2** to know what's happening with different order methods you proposed to get meta. – Ezequiel S. Sandoval Sep 08 '21 at 18:37
#1 is the most future way of getting the order meta. Especially as WC is moving to custom order tables: https://github.com/woocommerce/woocommerce/wiki/High-Performance-Order-Storage-Upgrade-Recipe-Book#apis-for-gettingsetting-posts-and-postmeta – Uriahs Victor Jan 22 '23 at 00:30

Woocommerce how to get meta value from the order object

Edit

1 Answers1

The following solutions have been fully tested on wordpress `5.8` and woocommerce `5+`.

They're recommended, if you use `update_post_meta` to store your metadata as part of the order object.

Woocommerce how to get meta value from the order object

Edit

1 Answers1

The following solutions have been fully tested on wordpress 5.8 and woocommerce 5+.

They're recommended, if you use update_post_meta to store your metadata as part of the order object.

The following solutions have been fully tested on wordpress `5.8` and woocommerce `5+`.

They're recommended, if you use `update_post_meta` to store your metadata as part of the order object.