Recommended method to add and store custom field that would better integrate with Messages

partyplus.it · January 29, 2025, 8:30pm

Dear HivePress Support,

I am reaching out because I have added a new field (phone number) to the message submission form using the following code:

add_filter( 'hivepress/v1/models/message', 'custom_add_message_fields', 1000 );
add_filter( 'hivepress/v1/forms/message_send', 'custom_add_message_fields', 1000);

function custom_add_message_fields($form){
    $form['fields']['custom_text_field'] = [
        'label'     => 'Custom field',
        'type'      => 'text',
        '_external' => true,
        '_order'    => 10,
    ];

    return $form;
}

add_filter(
    'hivepress/v1/models/message/attributes',
    function($attributes){
        $attributes['custom_text_field'] = [
            'editable' => true,
            'edit_field' => [
                'label'     => 'Custom field',
                'type'      => 'text',
                '_order'    => 10,
            ]
        ];
        
        return $attributes;
    },
    1000
);

Everything seems to be working correctly, but I am unsure where the value entered in this new field is actually stored. Specifically, I would like to know:

In which database table/column is the phone number stored (or the value entered in the custom_text_field), and how can I view or manage it within HivePress?
If there is a more efficient or recommended method to add and store custom fields, such as a phone number, that would better integrate with HivePress’s message structure.

Thank you in advance for your support. I look forward to your response.

Best regards,

Alessio

ihor · January 30, 2025, 6:03pm

Hi,

Yes, this is the correct way to add a new field and store it for messages. The second snippet for hivepress/v1/models/message/attributes is not needed, though. This new field is stored in wp_commentmeta database table (because message is a hidden comment type), with “hp_custom_text_field” meta key.

Another approach is adding a user attribute Phone and make it required, then it will be mandatory on registration. Since messages require registration anyway, you can collect the phone number once and then use it (for example) in the New Message email using %sender.phone% token.

Hope this helps

partyplus.it · January 31, 2025, 8:41am

Hello, I have modified the snippet to look like this.

add_filter( ‘hivepress/v1/models/message’, ‘custom_add_message_fields’, 1000 );
add_filter( ‘hivepress/v1/forms/message_send’, ‘custom_add_message_fields’, 1000);

function custom_add_message_fields($form){
	$form[‘fields’][‘custom_tel_field’] = [
		‘label’ => ‘custom field’,
		‘type’ => ‘text’,
		‘_external’ => true,
		‘_order’ => 10,
	];

	return $form;
}

As we understand it, the value to be entered will then be saved within the dedicated database. Using wordpress and siteground, the database can be accessed from phpmyadmin. I cannot find the table mentioned and the metakey. Could you please provide support regarding the navigation and display of the table?

ihor · February 2, 2025, 9:10pm

Please check if there’s a table with “commentmeta” in its name. This is the default WordPress database table so it’s there for sure, but the default prefix “wp_” can differ. If you want to display the phone number somewhere in the message layout I can provide general guidance on how to do this, let me know.

partyplus.it · February 4, 2025, 7:53pm

Grazie mille

Bruk · February 18, 2025, 1:56pm

Hi @ihor . I’m here exactly for the question asked by @partyplus.it. Can you please follow up and provide the guidance on how to actually get the new custom fields across to the recepient. My existing code in functions.php is like the following:

// Form modification filter
add_filter(‘hivepress/v1/forms/message_send’, function($form) {
if (‘messages_view_page’ === hivepress()->router->get_current_route_name()) {
return $form;
}

// Add custom fields to the form
$form['fields']['subject'] = [
    'label'       => 'Subject',
    'type'        => 'text',
    'required'    => true,
    'min_length'  => 5,
    'max_length'  => 50,
    '_order'      => 1,
];

$form['fields']['name'] = [
    'label'       => 'Name',
    'type'        => 'text',
    'placeholder' => 'محمد أحمد',
    'required'    => true,
    'min_length'  => 3,
    'max_length'  => 50,
    '_order'      => 2,
];

$form['fields']['email'] = [
    'label'       => 'e-mail',
    'type'        => 'email',
    'required'    => true,
    'min_length'  => 5,
    'max_length'  => 30,
    'placeholder' => 'mohammed.ahmed@example.com',
    '_order'      => 3,
];

return $form;

});

Upon sending the message, the recepient (in their messages space of their account) should see not just the message but also the additional fields. I read somewhere in one of your ‘questions’ page, customizing message_text.php in hivepress-messages is necessary. No clear guidance was given there and my attempts didn’t work. I hope this time, I’ll get the answer.

Thank you in advance.

Big thank you in advance.

condorito.fr · February 18, 2025, 2:15pm

Hello,

If you need extra/custom tokens, this may help :

Bruk · February 18, 2025, 2:27pm

Hi @condorito.fr. Thank you for sharing. Forgive me if I’m missing something here. What I would like is for the front end form values (in the code snippet above) on message to be sent to the recepient. Currently, despite those form fields, the recepient receives only the message.

I believe message_text.php in hivepress-messages handles this. This is the default code in it. Help is much appreciated!

<?php // Exit if accessed directly. defined( 'ABSPATH' ) || exit; ?>

<?php comment_text( $message->get_id() ); ?>

condorito.fr · February 18, 2025, 7:09pm

Maybe there’s a misunderstanding, but I would use the HivePress email templates :

And the message one, more specifically :

Bruk · February 18, 2025, 7:38pm

Thank you for the response @condorito.fr. The message form (as in the attached image) takes in subject, message text and attachment. But the recipient receives only the latter two. My wish is for the recipient to receive the subject including the message text and attachment. Everything that’s part of the form.

Please see the attached images as an example for the message form on the front end and the message the recipient sees.