apply_filters( “update_{$meta_type}_metadata”, null|bool $check, int $object_id, string $meta_key, mixed $meta_value, mixed $prev_value )

User Contributed Notes

1. Skip to note 3 content

   Steven Lin 4 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Example migrated from Codex:

   The example below skips saving the metadata with the key ‘foo’ and an empty value. For other metadata, continue the normal execution.

   add_action( 'init', 'wpdocs_init' );
   
   function wpdocs_init() {
      add_filter( 'update_user_metadata', 'wpdocs_update_foo', 10, 4 );
   }
   
   function wpdocs_update_foo( $check, $object_id, $meta_key, $meta_value ) {
   
      if ( 'foo' == $meta_key && empty( $meta_value ) ) {
         return false; // this means: stop saving the value into the database
      }
   
      return $check; // this means: go on with the normal execution in meta.php
   }
2. Skip to note 4 content

   crstauf 3 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   Similar to stevenlinx’s example, to skip saving empty value of foo to user metadata. Note that this could create problems if the user is attempting to clear previously entered data; an additional hook should be included that deletes the foo key from the user’s metadata if the value is empty.

   add_filter( 'update_user_metadata', function( $check, $object_id, $meta_key, $meta_value ) {
   
       // Already short-circuited; bail.
       if ( null !== $check )
           return $check;
   
       // Bail if not saving the 'foo' metadata.
       if ( 'foo' !== $meta_key )
           return null;
   
       // If meta value is not empty, then we _want_ to save it.
       if ( ! empty( $meta_value ) )
           return null;
   
       // Prevent saving empty value to user's 'foo' metadata.
       return false;
   }, 10, 4 );