Support » Plugin: Ultimate Member – User Profile, User Registration, Login & Membership Plugin » Hook right before user’s profile & custom field update?

  • Resolved ftpwp

    (@ftpwp)


    Hi,

    I want to use the power of UM custom fields to centralize the management of some settings on the UM profile, instead of the WP profile.

    For example: I have a website where the Asgaros forum is installed.
    Asgaros install 1 isolated setting asgarosforum_mention_notify in user’s WP profile.
    I don’t want users going to their WP profile just for that. I want to give them access to this setting in their UM profile.

    For that:
    – I’ve created a checkbox custom field in the UM profile
    – I’ve used the “um_user_after_updating_profile” hook to check what was the value set for the field after updating the UM profile and update accordingly the WP profile; align the 2 settings

    But… I now need to do the same thing BEFORE viewing or opening the UM profile: make sure I align the UM profile on the WP profile in case the setting has been changed on the WP profile.

    So what I need is to find:

    1/ the right hook to use to run my code before the UM user profile is viewed or edited. It should be one run at the very beginning when the code to build the UM user profile page (either in view or edit mode) starts, to still be able to update one custom field value.

    2/ the proper way to update a UM custom field value

    For this 2nd issue, I’ve found this…
    https://wordpress.org/support/topic/what-is-the-php-function-to-save-fields-in-um_user/#post-10965068
    …but so far it’s not working and it’s still not 100% clear to me.

    @wptechnology, I reply to your topic in mine as yours is closed.

    You suggest…

    global $ultimatemember;
    $user_id = um_user('ID');
    um_fetch_user($user_id);
    $toupdate[] = array('name_of_field' => 'its_value');
    UM()->user()->update_profile($toupdate);
    update_user_meta($user_id, 'name_of_field','its_value');

    In my context, 1 checkbox (value = ‘enable’) to update before the profile is viewed or created, I think it would become this (in functions.php – and I will already have the $user_id via the hook)…

    um_fetch_user($user_id);
    $toUpdate[] = array('profile_notif_new_mention' => 'enable');
    UM()->user()->update_profile($toUpdate);
    
    update_user_meta($user_id, 'profile_notif_new_post', 'enable');

    But I have several questions:

    1/ Is global $ultimatemember; still required in my case?

    2/ What’s the differences in between the UM()->user()->update_profile() and the update_user_meta() updates? What does UM()->user()->update_profile() updates that update_user_meta() does not?

    3/ How do we update checkboxes via UM()->user()->update_profile()? Do we really set the value in plain text or via an array like this array (0 => 'value')?

    4/ Same question for update_user_meta(). How do we update checkboxes to respect the UM format? Plain text or by an array like array (0 => 'value')? And do we have to use the [] after the meta_key, like profile_notif_new_post[]?

    I ask you those questions as something must be wrong. I have no error but it’s not working, the checkbox is not ticked in the user’s profile.

    Thanks!

Viewing 15 replies - 1 through 15 (of 20 total)
  • Thread Starter ftpwp

    (@ftpwp)

    Ok, I have the answer for the question 4: for checkboxes by need to use the array as value: array (0 => 'value'). Then this respects the UM specific format for the user_meta record value.

    Still need to find the appropriate hook and answer the questions 1 to 3 🙂

    Thread Starter ftpwp

    (@ftpwp)

    For question 1 & 3, I’ve tried everything I could, I really can not make UM()->user()->update_profile() work 🙁

    According to this function code, it’s also supposed to update the usermeta data, but it’s not so far and there’s not proper documentation with at least a description and an example…
    https://ultimatemember.com/php-docs/classes/um.core.User.html#method_update_profile

    But this function looks more complete than just a simple update_user_meta() (providing it works), as in some context, like the um_access_profile hook, if I just proceed a simple update_user_meta() the value is updated in the usermeta DB but not reflected on the UM user profile page. So it looks like a wider update it required, wider than just update_user_meta() and probably via UM()->user()->update_profile().

    So how do we use this UM()->user()->update_profile() for checkboxes?

    Plugin Contributor Champ Camba

    (@champsupertramp)

    Hi @ftpwp,

    1. You can use the action template_redirect and um_is_core_page("user") to modify any data before profile page and form are loaded.

    add_action("template_redirect","um_custom_profile_init", 10, 1 );
    function um_custom_profile_init(){
      
       if( um_is_core_page("user") ) {
         // if current page is profile page, do something...
       } 
    }

    2. The global $ultimatemember is depreciated since UM version 2.0. You can use the UM() without globalizing the old variable.

    3. UM()->user()->update_profile() – this is for updating mass fields. This is useful when your field has a role field. If there’s no Role field in the profile form, You can use the native update_user_meta in this case.

    4. IF you need to save a checkbox/radio field value, you must save the correct text case. e.g. IF your checkbox/radio field has 2 options( Enable & Disable ). You should save the value “Enable” and not “enable”.

    5. IF you need to save multiple field values of Multi-Select/Checkbox field, You should save it as an array.

    $arr_food = array("Apple","Bananas","Carrot"); 
    update_user_meta( 123, "favorite_food", $arr_food );
    

    Regards,

    • This reply was modified 2 years, 6 months ago by Champ Camba.
    • This reply was modified 2 years, 6 months ago by Champ Camba.
    Thread Starter ftpwp

    (@ftpwp)

    Hi @champsupertramp

    Thanks very much for your answer! 🙂

    1. You can use the action template_redirect and um_is_core_page("user")

    Ok. But I need the $user_id of the record/the user, we are about to view with this template/UM profile page (this $user_id being different from the current user id). Is this code appropriate to get it?

    $user_username = um_queried_user();
    $user = get_user_by('login', $user_username);
    $user_id = $user->ID;

    1. You can use the action template_redirect

    I have a concern with this WP hook. It looks like we’ll go through this test for nearly every click from every user on any page (as it’s a test ran every time someone arrives on a new page). Is there no other more specific UM hook, at the very beginning when the code to build the UM user profile page starts (either in view or edit mode)?

    3. UM()->user()->update_profile() – this is for updating mass fields. This is useful when your field has a role field.

    What do you call “role field”?

    If there’s no Role field in the profile form, You can use the native update_user_meta in this case.

    Well, so far update_user_meta properly updates the usermeta DB but the changes are not reflected on the profile page 🙁 It’s a bit weird, like if there was a kind of cache effect, or something else that also needs to be updated and was not :-/ Do you see what it is?

    Thread Starter ftpwp

    (@ftpwp)

    BTW, I don’t have any caching plugin.
    But maybe something is linked to the fact that it’s a custom field? :-/

    Plugin Contributor Champ Camba

    (@champsupertramp)

    Hi @ftpwp

    1. To retrieve the ID of current viewing profile, you can use this function um_profile_id(). Please see: https://docs.ultimatemember.com/article/34-get-the-current-user-profile-id

    2. You can try this action hook: um_before_form_is_loaded returns $args parameter: https://github.com/ultimatemember/ultimatemember/blob/master/includes/core/class-account.php#L283

    To check the current form mode, use this $args['mode'] – this will return the profile, register and login.

    3. Role field is a pre-defined field that you can add to the Register & Profile forms. This allows users to change their role.

    4. After updating the user meta, you can clear the user cache with the following code:

    UM()->user()->remove_cache( $user_id );

    Regards,

    Thread Starter ftpwp

    (@ftpwp)

    4. After updating the user meta, you can clear the user cache with the following code: UM()->user()->remove_cache( $user_id );

    Great, that’s exactly what I needed! 🙂
    Thanks.

    And from this starting point, the whole processes started to work so I could investigate a bit more the hook issue. In fact…
    template_redirect is definitively not the one to use (for my case). It’s called constantly, for ALL WP pages.
    um_before_form_is_loaded is much better. It’s limited to UM pages but still, it’s also called too often, for ALL UM forms.
    – So I think I found the one I was looking for: um_access_profile. This one is only called before loading the UM profile page (either in view or edit mode). It’s not even called before loading the UM account page, only the profile page, so it’s exactly what I was looking for. And… cherry on top of the cake, it’s providing the $user_id of the profile we’re about to open, no need to look for it and it’s early enough to still allow updating the user meta and see the changes in the profile once opened. The perfect hook I was looking for!

    3. Role field is a pre-defined field that you can add to the Register & Profile forms. This allows users to change their role.

    Ok.

    1. To retrieve the ID of current viewing profile, you can use this function um_profile_id().

    That’s returning the current user id. I was looking for the id of the profile we were about to open.

    Anyway, once again, in 2 messages you gave me all the solutions or right directions.
    Unless you see an issue using um_access_profile, my issue is solved.

    Thanks very much @champsupertramp ! 🙂

    Plugin Contributor Champ Camba

    (@champsupertramp)

    Hi @ftpwp,

    This thread has been inactive for a while so we’re going to go ahead and mark it Resolved.

    Please feel free to re-open this thread if any other questions come up and we’d be happy to help. 🙂

    Regards,

    @ftpwp
    Hi,

    have you a working solution to integrate the setting of asgarosforum_mention_notify in the profile edit?

    I’m not a developer, I’m just a hobbyist, so here in the topic I don’t understand so much here 😉

    Mybe you cann assist me?

    Best regards,
    Ole

    Thread Starter ftpwp

    (@ftpwp)

    Yes, I have the solution.

    I’ve centralized the notifications for new blog posts, new comments on the user’s blog posts and new mentions of the user on the Asgaros forum in the UM user’s profile.

    But I’m not at home this week so I’ll give u the solution this WE 😊

    @ftpwp thank you very much!

    Thread Starter ftpwp

    (@ftpwp)

    Ok, so what I’ve done is:

    • I did not remove the Asgaros Mention setting on the WP user profile form
    • I just added the same setting in the UM user profile form and did not communicate on the one on the WP form

    And to add the Mention setting on the UM user profile form, the solution I’ve used is the following:

    • I’ve created a custom checkbox field on the UM Profile form with “profile_new_mention_notification” as Meta Key and “Enabled” as Edit Choices
    • And I’ve added the following code in my child theme Functions.php…
    // When a new user registers, enable the Mention notification setting on the UM profile as it's enabled by default on Asgaros
    
    add_action('um_after_register_fields', 'add_a_hidden_field_to_register');
    
    function add_a_hidden_field_to_register( $args ) {
    	echo '<input type="hidden" name="Profile_new_mention_notification[]" value="Enabled" />';
    }
    
    // Check if the WP and the UM Mention settings are aligned. If not, align the UM one on the WP one prior to open the UM user profile form
    
    add_action( 'um_access_profile', 'align_mention_settings', 10, 1 );
    
    function align_mention_settings( $user_id ) {
    
    	// Check if the WP and the UM Mention settings are aligned
    	$mention_wp_settings = get_user_meta($user_id, 'asgarosforum_mention_notify', true); // yes, no or Empty = yes
    	$mention_wp_settings = ( $mention_wp_settings == "" ) ? "yes" : $mention_wp_settings;
    
    	$mention_um_settings = get_user_meta($user_id, 'profile_new_mention_notification', true);; // array() or Empty = no
    	$mention_um_settings = ( $mention_um_settings == "" ) ? "no" : "yes";
    
    	// If different, align the UM one on the WP one
    	if ( $mention_wp_settings <> $mention_um_settings ) {
    		if ( $mention_um_settings == "no" ) {
    			update_user_meta($user_id, 'profile_new_mention_notification', array (0 => 'Enabled'));
    		}
    		else {
    			delete_user_meta($user_id, 'profile_new_mention_notification', array (0 => 'Enabled'));
    		}
    		// Empty the user's cache to force the user_meta update to be immediately applied
    		UM()->user()->remove_cache( $user_id );
    	}
    }
    
    // Update the WP user Mention setting if the UM user profile is updated/saved
    
    add_action('um_user_after_updating_profile', 'apply_email_notification_settings', 10, 2);
    
    function apply_email_notification_settings( $submitted, $user_id ) {
    
    	// Check if 'profile_new_mention_notification' is ticked
    	if ( isset($submitted['profile_new_mention_notification']) ) {
    		// If ticked, tick the Asgaros field in the user WP profile
    		update_user_meta($user_id, 'asgarosforum_mention_notify', 'yes');
    	}
    	else {
    		// If unticked, untick the Asgaros field in the user WP profile
    		update_user_meta($user_id, 'asgarosforum_mention_notify', 'no');
    	}
    }

    That’s all! 🙂

    @ftpwp
    Thank you very much! It works 😉

    Did you also accidentally integrate the signature?

    Best regards,
    Ole

    Thread Starter ftpwp

    (@ftpwp)

    Did you also accidentally integrate the signature?

    What do you mean?

    That a user can change his asgaros forum signature in profile edit form?

Viewing 15 replies - 1 through 15 (of 20 total)
  • The topic ‘Hook right before user’s profile & custom field update?’ is closed to new replies.