GravityExport Developer Hooks

/**
 * Remove empty columns from the matrix.
 *
 * Filters out columns where all values (excluding the header) are empty.
 *
 * @since 1.0.0
 *
 * @param array $matrix The matrix containing all rows and columns. First row is the header.
 *
 * @return array The matrix with empty columns removed.
 */
function gfexcel_remove_empty_columns( $matrix ) {
    if ( empty( $matrix ) || count( $matrix ) < 2 ) {
        return $matrix; // Need header + at least one data row.
    }

    /**
     * Determine whether a cell value should be considered empty.
     *
     * Preserves 0, '0', 0.0, and false as non-empty.
     *
     * @param mixed $value The value to check.
     * @return bool
     */
    $is_empty = static function( $value ): bool {
        // Unwrap GFExcel value objects.
        if ( is_object( $value ) && method_exists( $value, 'getValue' ) ) {
            $value = $value->getValue();
        }

        // Empty arrays are empty; non-empty arrays are not.
        if ( is_array( $value ) ) {
            return count( $value ) === 0;
        }

        if ( is_string( $value ) ) {
            return '' === trim( $value );
        }

        return $value === null || $value === '';
    };

    $data_rows       = array_slice( $matrix, 1 );
    $column_count    = count( $matrix[0] );
    $columns_to_keep = [];

    // Find columns with at least one non-empty value.
    for ( $col_index = 0; $col_index < $column_count; $col_index++ ) {
        foreach ( $data_rows as $row ) {
            $val = $row[ $col_index ] ?? null;

            if ( ! $is_empty( $val ) ) {
                $columns_to_keep[] = $col_index;
                continue 2; // Skip to next column.
            }
        }
    }

    // Rebuild matrix keeping only non-empty columns.
    if ( empty( $columns_to_keep ) ) {
        // All columns empty: return empty rows with no columns.
        return array_fill( 0, count( $matrix ), [] );
    }

    $keep_flip = array_flip( $columns_to_keep );

    return array_map(
        static function( $row ) use ( $keep_flip ) {
            return array_values( array_intersect_key( $row, $keep_flip ) );
        },
        $matrix
    );
}

add_filter( 'gfexcel_renderer_matrix', 'gfexcel_remove_empty_columns' );

/**
 * Remove empty columns from the matrix.
 *
 * Filters out columns where all values (excluding the header) are empty.
 *
 * @since 1.0.0
 *
 * @param array $matrix The matrix containing all rows and columns. First row is the header.
 *
 * @return array The matrix with empty columns removed.
 */
function gfexcel_remove_empty_columns( $matrix ) {
    if ( empty( $matrix ) || count( $matrix ) < 2 ) {
        return $matrix; // Need header + at least one data row.
    }

    /**
     * Determine whether a cell value should be considered empty.
     *
     * Preserves 0, '0', 0.0, and false as non-empty.
     *
     * @param mixed $value The value to check.
     * @return bool
     */
    $is_empty = static function( $value ): bool {
        // Unwrap GFExcel value objects.
        if ( is_object( $value ) && method_exists( $value, 'getValue' ) ) {
            $value = $value->getValue();
        }

        // Empty arrays are empty; non-empty arrays are not.
        if ( is_array( $value ) ) {
            return count( $value ) === 0;
        }

        if ( is_string( $value ) ) {
            return '' === trim( $value );
        }

        return $value === null || $value === '';
    };

    $data_rows       = array_slice( $matrix, 1 );
    $column_count    = count( $matrix[0] );
    $columns_to_keep = [];

    // Find columns with at least one non-empty value.
    for ( $col_index = 0; $col_index < $column_count; $col_index++ ) {
        foreach ( $data_rows as $row ) {
            $val = $row[ $col_index ] ?? null;

            if ( ! $is_empty( $val ) ) {
                $columns_to_keep[] = $col_index;
                continue 2; // Skip to next column.
            }
        }
    }

    // Rebuild matrix keeping only non-empty columns.
    if ( empty( $columns_to_keep ) ) {
        // All columns empty: return empty rows with no columns.
        return array_fill( 0, count( $matrix ), [] );
    }

    $keep_flip = array_flip( $columns_to_keep );

    return array_map(
        static function( $row ) use ( $keep_flip ) {
            return array_values( array_intersect_key( $row, $keep_flip ) );
        },
        $matrix
    );
}

add_filter( 'gfexcel_renderer_matrix', 'gfexcel_remove_empty_columns' );

/**
 * Remove the header row from the export.
 *
 * @param mixed[] $matrix The matrix containing all rows and columns.
 * @return mixed[] The matrix without its first row.
 */
add_filter( 'gfexcel_renderer_matrix', function( $matrix ) {
    unset( $matrix[0] ); // Remove the first (header) row.
    return array_values( $matrix ); // Re-index the rows so they start at 0 again.
} );

/**
 * Remove the header row from the export.
 *
 * @param mixed[] $matrix The matrix containing all rows and columns.
 * @return mixed[] The matrix without its first row.
 */
add_filter( 'gfexcel_renderer_matrix', function( $matrix ) {
    unset( $matrix[0] ); // Remove the first (header) row.
    return array_values( $matrix ); // Re-index the rows so they start at 0 again.
} );

/**
 * Hide rows where field 1 (a single-input field) is empty.
 *
 * @param bool  $hide Whether to hide the row.
 * @param array $row  The row's cells: value objects, or null for an empty cell.
 * @return bool True to hide the row.
 */
function gravityexport_hide_empty_field_rows( $hide, $row ) {
    foreach ( $row as $cell ) {
        if ( is_object( $cell ) && '1' === $cell->getFieldId() && '' === $cell->getValue() ) {
            return true;
        }
    }

    return $hide;
}
add_filter( 'gfexcel_renderer_hide_row', 'gravityexport_hide_empty_field_rows', 10, 2 );

/**
 * Hide rows where field 1 (a single-input field) is empty.
 *
 * @param bool  $hide Whether to hide the row.
 * @param array $row  The row's cells: value objects, or null for an empty cell.
 * @return bool True to hide the row.
 */
function gravityexport_hide_empty_field_rows( $hide, $row ) {
    foreach ( $row as $cell ) {
        if ( is_object( $cell ) && '1' === $cell->getFieldId() && '' === $cell->getValue() ) {
            return true;
        }
    }

    return $hide;
}
add_filter( 'gfexcel_renderer_hide_row', 'gravityexport_hide_empty_field_rows', 10, 2 );

/**
 * Limit column width to 50 units.
 *
 * @param int|null $max_width The maximum column width.
 * @return int The new maximum width.
 */
function gravityexport_set_max_column_width( $max_width ) {
    return 50;
}
add_filter( 'gfexcel_renderer_columns_max_width', 'gravityexport_set_max_column_width' );

/**
 * Limit column width to 50 units.
 *
 * @param int|null $max_width The maximum column width.
 * @return int The new maximum width.
 */
function gravityexport_set_max_column_width( $max_width ) {
    return 50;
}
add_filter( 'gfexcel_renderer_columns_max_width', 'gravityexport_set_max_column_width' );

/**
 * Disable text wrapping for all cells.
 *
 * @return bool False to disable text wrapping.
 */
add_filter( 'gfexcel_renderer_wrap_text', '__return_false' );

/**
 * Disable text wrapping for all cells.
 *
 * @return bool False to disable text wrapping.
 */
add_filter( 'gfexcel_renderer_wrap_text', '__return_false' );

/**
 * Add the form ID to the worksheet title.
 *
 * @param string $title The worksheet title.
 * @param array  $form  The form object.
 * @return string Modified worksheet title (cut to 31 characters).
 */
function gravityexport_custom_worksheet_title( $title, $form ) {
    return sprintf( 'Form %d - %s', $form['id'], $title );
}
add_filter( 'gfexcel_renderer_worksheet_title', 'gravityexport_custom_worksheet_title', 10, 2 );

/**
 * Add the form ID to the worksheet title.
 *
 * @param string $title The worksheet title.
 * @param array  $form  The form object.
 * @return string Modified worksheet title (cut to 31 characters).
 */
function gravityexport_custom_worksheet_title( $title, $form ) {
    return sprintf( 'Form %d - %s', $form['id'], $title );
}
add_filter( 'gfexcel_renderer_worksheet_title', 'gravityexport_custom_worksheet_title', 10, 2 );

/**
 * Disable all hyperlinks in export.
 *
 * @return bool True to disable hyperlinks.
 */
add_filter( 'gfexcel_renderer_disable_hyperlinks', '__return_true' );

/**
 * Disable all hyperlinks in export.
 *
 * @return bool True to disable hyperlinks.
 */
add_filter( 'gfexcel_renderer_disable_hyperlinks', '__return_true' );

/**
 * Leave out entries whose field 1 contains "test".
 *
 * @param array $rows    The rows. Each row holds value objects (or null) in column order.
 * @param int   $form_id The form ID.
 * @return array Filtered rows.
 */
function gravityexport_remove_test_entries( $rows, $form_id ) {
    return array_values( array_filter( $rows, function( $row ) {
        foreach ( $row as $cell ) {
            if ( is_object( $cell ) && '1' === $cell->getFieldId() && false !== stripos( $cell->getValue(), 'test' ) ) {
                return false;
            }
        }

        return true;
    } ) );
}
add_filter( 'gfexcel_output_rows', 'gravityexport_remove_test_entries', 10, 2 );

/**
 * Leave out entries whose field 1 contains "test".
 *
 * @param array $rows    The rows. Each row holds value objects (or null) in column order.
 * @param int   $form_id The form ID.
 * @return array Filtered rows.
 */
function gravityexport_remove_test_entries( $rows, $form_id ) {
    return array_values( array_filter( $rows, function( $row ) {
        foreach ( $row as $cell ) {
            if ( is_object( $cell ) && '1' === $cell->getFieldId() && false !== stripos( $cell->getValue(), 'test' ) ) {
                return false;
            }
        }

        return true;
    } ) );
}
add_filter( 'gfexcel_output_rows', 'gravityexport_remove_test_entries', 10, 2 );

/**
 * Leave the User IP and User Agent columns out of the export.
 *
 * @param bool     $disabled Whether the field is left out.
 * @param GF_Field $field    The field object.
 * @return bool True to leave the field out.
 */
function gravityexport_disable_ip_columns( $disabled, $field ) {
    if ( in_array( (string) $field->id, [ 'ip', 'user_agent' ], true ) ) {
        return true;
    }

    return $disabled;
}
add_filter( 'gfexcel_field_disable', 'gravityexport_disable_ip_columns', 10, 2 );

/**
 * Leave the User IP and User Agent columns out of the export.
 *
 * @param bool     $disabled Whether the field is left out.
 * @param GF_Field $field    The field object.
 * @return bool True to leave the field out.
 */
function gravityexport_disable_ip_columns( $disabled, $field ) {
    if ( in_array( (string) $field->id, [ 'ip', 'user_agent' ], true ) ) {
        return true;
    }

    return $disabled;
}
add_filter( 'gfexcel_field_disable', 'gravityexport_disable_ip_columns', 10, 2 );

/**
 * Only export entries from last 30 days.
 *
 * @param array $search_criteria The search criteria.
 * @param int   $form_id         The form ID.
 * @param int   $feed_id         The feed ID.
 * @return array Modified search criteria.
 */
function gravityexport_last_30_days( $search_criteria, $form_id, $feed_id ) {
    $search_criteria['start_date'] = date( 'Y-m-d', strtotime( '-30 days' ) );
    $search_criteria['end_date']   = date( 'Y-m-d' );

    return $search_criteria;
}
add_filter( 'gfexcel_output_search_criteria', 'gravityexport_last_30_days', 10, 3 );

/**
 * Only export entries from last 30 days.
 *
 * @param array $search_criteria The search criteria.
 * @param int   $form_id         The form ID.
 * @param int   $feed_id         The feed ID.
 * @return array Modified search criteria.
 */
function gravityexport_last_30_days( $search_criteria, $form_id, $feed_id ) {
    $search_criteria['start_date'] = date( 'Y-m-d', strtotime( '-30 days' ) );
    $search_criteria['end_date']   = date( 'Y-m-d' );

    return $search_criteria;
}
add_filter( 'gfexcel_output_search_criteria', 'gravityexport_last_30_days', 10, 3 );

/**
 * Sort by entry ID descending.
 *
 * @param array $sorting The sorting options.
 * @param int   $form_id The form ID.
 * @param int   $feed_id The feed ID.
 * @return array Modified sorting options.
 */
function gravityexport_sort_by_id_desc( $sorting, $form_id, $feed_id ) {
    return [
        'key'       => 'id',
        'direction' => 'DESC',
    ];
}
add_filter( 'gfexcel_output_sorting_options', 'gravityexport_sort_by_id_desc', 10, 3 );

/**
 * Sort by entry ID descending.
 *
 * @param array $sorting The sorting options.
 * @param int   $form_id The form ID.
 * @param int   $feed_id The feed ID.
 * @return array Modified sorting options.
 */
function gravityexport_sort_by_id_desc( $sorting, $form_id, $feed_id ) {
    return [
        'key'       => 'id',
        'direction' => 'DESC',
    ];
}
add_filter( 'gfexcel_output_sorting_options', 'gravityexport_sort_by_id_desc', 10, 3 );

/**
 * Write "No" when no choice of a checkbox field is checked.
 *
 * @param string   $empty_value The value to write. Default ''.
 * @param array    $entry       The entry object.
 * @param GF_Field $field       The checkbox field object.
 * @return string The new value.
 */
function gravityexport_checkbox_empty_no( $empty_value, $entry, $field ) {
    return 'No';
}
add_filter( 'gfexcel_field_checkbox_empty', 'gravityexport_checkbox_empty_no', 10, 3 );

/**
 * Write "No" when no choice of a checkbox field is checked.
 *
 * @param string   $empty_value The value to write. Default ''.
 * @param array    $entry       The entry object.
 * @param GF_Field $field       The checkbox field object.
 * @return string The new value.
 */
function gravityexport_checkbox_empty_no( $empty_value, $entry, $field ) {
    return 'No';
}
add_filter( 'gfexcel_field_checkbox_empty', 'gravityexport_checkbox_empty_no', 10, 3 );

/**
 * Write all Date fields as year-month-day, for example 2026-09-23.
 *
 * @param string $format The Gravity Forms date format key.
 * @return string The new date format key.
 */
function gravityexport_ymd_date_format( $format ) {
    return 'ymd_dash';
}
add_filter( 'gfexcel_field_date_format', 'gravityexport_ymd_date_format' );

/**
 * Write all Date fields as year-month-day, for example 2026-09-23.
 *
 * @param string $format The Gravity Forms date format key.
 * @return string The new date format key.
 */
function gravityexport_ymd_date_format( $format ) {
    return 'ymd_dash';
}
add_filter( 'gfexcel_field_date_format', 'gravityexport_ymd_date_format' );

/**
 * Separate checked checkbox choices with a semicolon.
 *
 * Priority 20 runs after GravityExport sets ', ' on this filter at priority 10.
 *
 * @param string $glue The separator.
 * @return string The new separator.
 */
function gravityexport_checkbox_glue( $glue ) {
    return '; ';
}
add_filter( 'gfexcel_combiner_glue_checkbox', 'gravityexport_checkbox_glue', 20 );

/**
 * Separate checked checkbox choices with a semicolon.
 *
 * Priority 20 runs after GravityExport sets ', ' on this filter at priority 10.
 *
 * @param string $glue The separator.
 * @return string The new separator.
 */
function gravityexport_checkbox_glue( $glue ) {
    return '; ';
}
add_filter( 'gfexcel_combiner_glue_checkbox', 'gravityexport_checkbox_glue', 20 );

/**
 * Use CSV format for form ID 5.
 *
 * @param string $extension The file extension.
 * @param array  $form      The form object.
 * @return string The file extension.
 */
function gravityexport_csv_for_form_5( $extension, $form ) {
    if ( 5 === (int) rgar( $form, 'id' ) ) {
        return 'csv';
    }

    return $extension;
}
add_filter( 'gfexcel_file_extension', 'gravityexport_csv_for_form_5', 10, 2 );

/**
 * Use CSV format for form ID 5.
 *
 * @param string $extension The file extension.
 * @param array  $form      The form object.
 * @return string The file extension.
 */
function gravityexport_csv_for_form_5( $extension, $form ) {
    if ( 5 === (int) rgar( $form, 'id' ) ) {
        return 'csv';
    }

    return $extension;
}
add_filter( 'gfexcel_file_extension', 'gravityexport_csv_for_form_5', 10, 2 );

/**
 * Add custom export format.
 *
 * @param array $extensions Supported extensions.
 * @return array Modified extensions array.
 */
function gravityexport_add_custom_format( $extensions ) {
    $extensions[] = 'ods'; // OpenDocument Spreadsheet

    return $extensions;
}
add_filter( 'gfexcel_file_extensions', 'gravityexport_add_custom_format' );

/**
 * Add custom export format.
 *
 * @param array $extensions Supported extensions.
 * @return array Modified extensions array.
 */
function gravityexport_add_custom_format( $extensions ) {
    $extensions[] = 'ods'; // OpenDocument Spreadsheet

    return $extensions;
}
add_filter( 'gfexcel_file_extensions', 'gravityexport_add_custom_format' );

/**
 * Use semicolon delimiter for CSV.
 *
 * @param string $delimiter The delimiter.
 * @param int    $form_id   The form ID. Not passed by every export path.
 * @return string The new delimiter.
 */
function gravityexport_semicolon_delimiter( $delimiter, $form_id = 0 ) {
    return ';';
}
add_filter( 'gfexcel_renderer_csv_delimiter', 'gravityexport_semicolon_delimiter', 10, 2 );

/**
 * Use semicolon delimiter for CSV.
 *
 * @param string $delimiter The delimiter.
 * @param int    $form_id   The form ID. Not passed by every export path.
 * @return string The new delimiter.
 */
function gravityexport_semicolon_delimiter( $delimiter, $form_id = 0 ) {
    return ';';
}
add_filter( 'gfexcel_renderer_csv_delimiter', 'gravityexport_semicolon_delimiter', 10, 2 );

/**
 * Add UTF-8 BOM for Excel compatibility.
 *
 * @param bool $use_bom Whether to use BOM.
 * @param int  $form_id The form ID.
 * @return bool True to include BOM.
 */
function gravityexport_enable_bom( $use_bom, $form_id ) {
    return true;
}
add_filter( 'gfexcel_renderer_csv_use_bom', 'gravityexport_enable_bom', 10, 2 );

/**
 * Add UTF-8 BOM for Excel compatibility.
 *
 * @param bool $use_bom Whether to use BOM.
 * @param int  $form_id The form ID.
 * @return bool True to include BOM.
 */
function gravityexport_enable_bom( $use_bom, $form_id ) {
    return true;
}
add_filter( 'gfexcel_renderer_csv_use_bom', 'gravityexport_enable_bom', 10, 2 );

/**
 * Keep Name fields in a single column.
 *
 * @return bool False to keep the field in one column.
 */
add_filter( 'gfexcel_field_separated_name', '__return_false' );

/**
 * Keep Name fields in a single column.
 *
 * @return bool False to keep the field in one column.
 */
add_filter( 'gfexcel_field_separated_name', '__return_false' );

/**
 * Add the field ID to column headers.
 *
 * @param string   $label The column header label.
 * @param GF_Field $field The field object.
 * @return string Modified label.
 */
function gravityexport_add_id_to_label( $label, $field ) {
    return sprintf( '%s (ID: %s)', $label, $field->id );
}
add_filter( 'gfexcel_field_label', 'gravityexport_add_id_to_label', 10, 2 );

/**
 * Add the field ID to column headers.
 *
 * @param string   $label The column header label.
 * @param GF_Field $field The field object.
 * @return string Modified label.
 */
function gravityexport_add_id_to_label( $label, $field ) {
    return sprintf( '%s (ID: %s)', $label, $field->id );
}
add_filter( 'gfexcel_field_label', 'gravityexport_add_id_to_label', 10, 2 );

/**
 * Write the values of field 3 (a Single Line Text field) on form 5 in uppercase.
 *
 * @param mixed $value The field value.
 * @return mixed The new value.
 */
function gravityexport_uppercase_field_value( $value ) {
    return is_string( $value ) ? strtoupper( $value ) : $value;
}
add_filter( 'gfexcel_field_value_text_5_3', 'gravityexport_uppercase_field_value' );

/**
 * Write the values of field 3 (a Single Line Text field) on form 5 in uppercase.
 *
 * @param mixed $value The field value.
 * @return mixed The new value.
 */
function gravityexport_uppercase_field_value( $value ) {
    return is_string( $value ) ? strtoupper( $value ) : $value;
}
add_filter( 'gfexcel_field_value_text_5_3', 'gravityexport_uppercase_field_value' );

/**
 * Make header row bold with background color.
 *
 * @param Cell  $cell    The cell object.
 * @param mixed $value   The cell value.
 * @param int   $form_id The form ID.
 */
function gravityexport_style_header_row( $cell, $value, $form_id ) {
    if ( 1 !== $cell->getRow() ) {
        return;
    }

    $cell->getStyle()->getFont()->setBold( true );
    $cell->getStyle()->getFill()
        ->setFillType( 'solid' ) // Fill::FILL_SOLID
        ->getStartColor()->setRGB( 'CCCCCC' );
}
add_action( 'gfexcel_renderer_cell_properties', 'gravityexport_style_header_row', 10, 3 );

/**
 * Make header row bold with background color.
 *
 * @param Cell  $cell    The cell object.
 * @param mixed $value   The cell value.
 * @param int   $form_id The form ID.
 */
function gravityexport_style_header_row( $cell, $value, $form_id ) {
    if ( 1 !== $cell->getRow() ) {
        return;
    }

    $cell->getStyle()->getFont()->setBold( true );
    $cell->getStyle()->getFill()
        ->setFillType( 'solid' ) // Fill::FILL_SOLID
        ->getStartColor()->setRGB( 'CCCCCC' );
}
add_action( 'gfexcel_renderer_cell_properties', 'gravityexport_style_header_row', 10, 3 );

/**
 * Write "N/A" instead of an empty cell for form 12.
 *
 * @param array[] $rows    The page's rows.
 * @param int     $form_id The form ID.
 * @param int     $offset  Entries skipped before this page.
 * @return array[] Modified rows.
 */
function gravityexport_sheets_fill_blanks( $rows, $form_id, $offset ) {
    if ( 12 !== (int) $form_id ) {
        return $rows;
    }

    foreach ( $rows as &$row ) {
        foreach ( $row as &$cell ) {
            if ( null === $cell || '' === $cell ) {
                $cell = 'N/A';
            }
        }
    }

    return $rows;
}
add_filter( 'gk/gravityexport/sheets/rows-page', 'gravityexport_sheets_fill_blanks', 10, 3 );

/**
 * Write "N/A" instead of an empty cell for form 12.
 *
 * @param array[] $rows    The page's rows.
 * @param int     $form_id The form ID.
 * @param int     $offset  Entries skipped before this page.
 * @return array[] Modified rows.
 */
function gravityexport_sheets_fill_blanks( $rows, $form_id, $offset ) {
    if ( 12 !== (int) $form_id ) {
        return $rows;
    }

    foreach ( $rows as &$row ) {
        foreach ( $row as &$cell ) {
            if ( null === $cell || '' === $cell ) {
                $cell = 'N/A';
            }
        }
    }

    return $rows;
}
add_filter( 'gk/gravityexport/sheets/rows-page', 'gravityexport_sheets_fill_blanks', 10, 3 );

/**
 * Email the site admin when a cloud connection goes offline.
 *
 * @param MonitorableConnection $provider The offline connection.
 */
function gravityexport_notify_connection_offline( $provider ) {
    wp_mail(
        get_option( 'admin_email' ),
        sprintf( 'GravityExport: %s connection is offline', $provider->getTitle() ),
        'Reconnect it under GravityKit > Settings > GravityExport before scheduled exports fail.'
    );
}
add_action( 'gk/gravityexport/save/monitored-connection/failed', 'gravityexport_notify_connection_offline' );

/**
 * Email the site admin when a cloud connection goes offline.
 *
 * @param MonitorableConnection $provider The offline connection.
 */
function gravityexport_notify_connection_offline( $provider ) {
    wp_mail(
        get_option( 'admin_email' ),
        sprintf( 'GravityExport: %s connection is offline', $provider->getTitle() ),
        'Reconnect it under GravityKit > Settings > GravityExport before scheduled exports fail.'
    );
}
add_action( 'gk/gravityexport/save/monitored-connection/failed', 'gravityexport_notify_connection_offline' );

/**
 * Don't carry a per-form note over when a feed is copied.
 *
 * @param string $action         'copy' or 'drop'.
 * @param string $key            The unrecognized meta key.
 * @param mixed  $value          Its value.
 * @param array  $source_meta    The source feed meta.
 * @param int    $target_form_id The target form ID.
 * @return string 'copy' or 'drop'.
 */
function gravityexport_drop_note_on_copy( $action, $key, $value, $source_meta, $target_form_id ) {
    if ( 'my_plugin_form_note' === $key ) {
        return 'drop';
    }

    return $action;
}
add_filter( 'gk/gravityexport/save/feed-copy/unknown-key', 'gravityexport_drop_note_on_copy', 10, 5 );

/**
 * Don't carry a per-form note over when a feed is copied.
 *
 * @param string $action         'copy' or 'drop'.
 * @param string $key            The unrecognized meta key.
 * @param mixed  $value          Its value.
 * @param array  $source_meta    The source feed meta.
 * @param int    $target_form_id The target form ID.
 * @return string 'copy' or 'drop'.
 */
function gravityexport_drop_note_on_copy( $action, $key, $value, $source_meta, $target_form_id ) {
    if ( 'my_plugin_form_note' === $key ) {
        return 'drop';
    }

    return $action;
}
add_filter( 'gk/gravityexport/save/feed-copy/unknown-key', 'gravityexport_drop_note_on_copy', 10, 5 );

/**
 * Log every successful scheduled export.
 *
 * @param array $feed      The Gravity Forms feed array.
 * @param int   $row_count The number of rows exported.
 */
function gravityexport_log_scheduled_export( $feed, $row_count ) {
    error_log( sprintf(
        'GravityExport: feed %d on form %d exported %d rows.',
        $feed['id'],
        $feed['form_id'],
        $row_count
    ) );
}
add_action( 'gk/gravityexport/save/cron/completed', 'gravityexport_log_scheduled_export', 10, 2 );

/**
 * Log every successful scheduled export.
 *
 * @param array $feed      The Gravity Forms feed array.
 * @param int   $row_count The number of rows exported.
 */
function gravityexport_log_scheduled_export( $feed, $row_count ) {
    error_log( sprintf(
        'GravityExport: feed %d on form %d exported %d rows.',
        $feed['id'],
        $feed['form_id'],
        $row_count
    ) );
}
add_action( 'gk/gravityexport/save/cron/completed', 'gravityexport_log_scheduled_export', 10, 2 );

/**
 * Email the site admin when a scheduled export fails.
 *
 * @param array      $feed The Gravity Forms feed array.
 * @param \Throwable $e    The error or exception that caused the failure.
 */
function gravityexport_notify_export_failed( $feed, $e ) {
    wp_mail(
        get_option( 'admin_email' ),
        sprintf( 'GravityExport: scheduled export failed for feed %d', $feed['id'] ),
        $e->getMessage()
    );
}
add_action( 'gk/gravityexport/save/cron/failed', 'gravityexport_notify_export_failed', 10, 2 );

/**
 * Email the site admin when a scheduled export fails.
 *
 * @param array      $feed The Gravity Forms feed array.
 * @param \Throwable $e    The error or exception that caused the failure.
 */
function gravityexport_notify_export_failed( $feed, $e ) {
    wp_mail(
        get_option( 'admin_email' ),
        sprintf( 'GravityExport: scheduled export failed for feed %d', $feed['id'] ),
        $e->getMessage()
    );
}
add_action( 'gk/gravityexport/save/cron/failed', 'gravityexport_notify_export_failed', 10, 2 );

/**
 * Log manual export runs.
 *
 * @param array $feed The Gravity Forms feed array.
 */
function gravityexport_log_manual_export( $feed ) {
    error_log( sprintf( 'GravityExport: feed %d was exported manually.', $feed['id'] ) );
}
add_action( 'gk/gravityexport/save/exported/manual', 'gravityexport_log_manual_export' );

/**
 * Log manual export runs.
 *
 * @param array $feed The Gravity Forms feed array.
 */
function gravityexport_log_manual_export( $feed ) {
    error_log( sprintf( 'GravityExport: feed %d was exported manually.', $feed['id'] ) );
}
add_action( 'gk/gravityexport/save/exported/manual', 'gravityexport_log_manual_export' );

/**
 * Log every entry an Automatic Save feed exports.
 *
 * @param array                $entry        The entry object.
 * @param array                $form         The form object.
 * @param array                $feed         The Gravity Forms feed array.
 * @param StorageTypeInterface $storage_type The destination.
 */
function gravityexport_log_entry_export( $entry, $form, $feed, $storage_type ) {
    error_log( sprintf(
        'GravityExport: feed %d exported entry %d to %s.',
        $feed['id'],
        $entry['id'],
        $storage_type->getTitle()
    ) );
}
add_action( 'gk/gravityexport/save/exported/entry', 'gravityexport_log_entry_export', 10, 4 );

/**
 * Log every entry an Automatic Save feed exports.
 *
 * @param array                $entry        The entry object.
 * @param array                $form         The form object.
 * @param array                $feed         The Gravity Forms feed array.
 * @param StorageTypeInterface $storage_type The destination.
 */
function gravityexport_log_entry_export( $entry, $form, $feed, $storage_type ) {
    error_log( sprintf(
        'GravityExport: feed %d exported entry %d to %s.',
        $feed['id'],
        $entry['id'],
        $storage_type->getTitle()
    ) );
}
add_action( 'gk/gravityexport/save/exported/entry', 'gravityexport_log_entry_export', 10, 4 );

/**
 * Run Save feed 42 right now, for example from a custom WP-CLI command.
 */
do_action( 'gk/gravityexport/save/action/save-feed', 42 );

/**
 * Run Save feed 42 right now, for example from a custom WP-CLI command.
 */
do_action( 'gk/gravityexport/save/action/save-feed', 42 );