Merge pull request #190 from Prospress/issue_138

Exporting custom meta

Author: Brent Shepherd

README.md

@@ -622,6 +622,46 @@ Before exporting, you have the option to modify the column names which are writt
 `tax_items`               |`string`|Taxes|
 `download_permissions`    |`int`|Download permissions granted (1 or 0)|
 
+## FAQ
+
+#### Can I export custom meta?
+
+Sure can! You will need to:
+
+1. Use the `wcsie_export_headers` to add your custom header so that it's exported in the CSV and;
+2. Use `wcsie_format_export_value` to append the custom export data to each exported row.
+
+```
+/**
+ * Add custom headers to the list of default headers exported in the CSV
+ *
+ * @param array $headers
+ * @return array
+ */
+function my_custom_export_headers( $headers = array() ) {
+    return array_merge( $headers, array(
+        'shipping_code' => 'Shipping Code',
+    ) );
+}
+add_filter( 'wcsie_export_headers', 'my_custom_export_headers', 10, 1 );
+
+/**
+ * Adds a custom meta value to the exported row
+ *
+ * @param string value
+ * @param WC_Subscription $subscription
+ * @param
+ * @return string
+ */
+ function my_custom_export_values( $value, $subscription, $header_key ) {
+    if ( 'shipping_code' == $header_key && empty( $value ) ) {
+        $value = $subscription->shipping_code;
+    }
+
+    return $value;
+ }
+add_filter( 'wcsie_format_export_value', 'my_custom_export_values', 10, 3 );
+```
 
 ---
 

includes/class-wcs-export-admin.php

@@ -178,7 +178,7 @@ public function home_page() {
 	 */
 	public function export_headers() {
 
-		$csv_headers = array(
+		$csv_headers = apply_filters( 'wcsie_export_headers', array(
 			'subscription_id'          => __( 'Subscription ID', 'wcs-import-export' ),
 			'subscription_status'      => __( 'Subscription Status', 'wcs-import-export' ),
 			'customer_id'              => __( 'Customer ID', 'wcs-import-export' ),
@@ -231,7 +231,7 @@ public function export_headers() {
 			'fee_items'                => __( 'Fees', 'wcs-import-export' ),
 			'tax_items'                => __( 'Taxes', 'wcs-import-export' ),
 			'download_permissions'     => __( 'Download Permissions Granted', 'wcs-import-export' ),
-		);
+		) );
 		?>
 
 		<table class="widefat widefat_importer striped" id="wcsi-headers-table" style="display:none;">

includes/class-wcs-exporter.php

@@ -380,9 +380,11 @@ public static function write_subscriptions_csv_row( $subscription ) {
 					$value = '';
 			}
 
-			$csv_row[ $header_key ] = $value;
+			$csv_row[ $header_key ] = apply_filters( 'wcsie_format_export_value', $value, $subscription, $header_key );
 		}
 
+		$csv_row = apply_filters( 'wcsie_format_export_csv_row', $csv_row, $subscription, self::$headers );
+
 		self::write( $csv_row );
 	}