Ultimate Member

https://docs.ultimatemember.com/
Admin
Ultimate Member is a WordPress plugin that enables user profile creation, user registration, and...
Tokens:145,194
Snippets:1,490
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Implementation

Source: https://docs.ultimatemember.com/article/1422-umthemesinglepostbottom

A complete example showing how to define a function and hook it to um_theme_single_post_bottom.

```php
<?php
add_action( 'um_theme_single_post_bottom', 'my_theme_post' );

function my_theme_post() { 
	// your code here;
 } 
?>
```

--------------------------------

### Example implementation of um_theme_single_post_before

Source: https://docs.ultimatemember.com/article/1418-umthemesinglepostbefore

A complete example showing how to register the action and define the callback function.

```php
<?php
add_action( 'um_theme_single_post_before', 'my_theme_post' );

function my_theme_post() { 
	// your code here;
 } 
?>
```

--------------------------------

### Example implementation of um_before_submit_form_post

Source: https://docs.ultimatemember.com/article/1063-umbeforesubmitformpost

A practical example showing how to hook into the form submission process.

```php
<?php
add_action( 'um_before_submit_form_post', 'my_before_submit_form_post', 10, 1 );
function my_run_ajax_function( $post ) {
    // your code here
}
?>
```

--------------------------------

### Example implementation of um_before_{$mode}_fields

Source: https://docs.ultimatemember.com/article/1171-ummainmodefields

A complete example showing how to register the action and define the callback function.

```php
<?php
add_action( 'um_before_{$mode}_fields', 'my_before_fields', 10, 1 );
function my_before_form( $args ) {
    // your code here
}
?>
```

--------------------------------

### Example implementation of um_after_user_status_is_changed

Source: https://docs.ultimatemember.com/article/1036-umafteruserstatusischanged

A complete example showing how to define a callback function for the um_after_user_status_is_changed hook.

```php
<?php
add_action( 'um_after_user_status_is_changed', 'my_after_user_status_is_changed', 10, 1 );
function my_after_user_status_is_changed( $status ) {
    // your code here
}
?>
```

--------------------------------

### Example: Custom function for um_theme_single_post_top

Source: https://docs.ultimatemember.com/article/1420-umthemesingleposttop

Example implementation of a custom function hooked to um_theme_single_post_top, with a placeholder for user code.

```php
<?php
add_action( 'um_theme_single_post_top', 'my_theme_post' );

function my_theme_post() { 
	// your code here;
 } 
?>
```

--------------------------------

### Example implementation of um_default_settings_values filter

Source: https://docs.ultimatemember.com/article/1101-umdefaultsettingsvalues

Example implementation of the um_default_settings_values filter. The callback receives the $settings array and should return it after modifications.

```php
<?php
add_filter( 'um_default_settings_values', 'my_default_settings_values', 10, 1 );
function my_default_settings_values( $settings ) {
    // your code here
return $settings;
}
?>
```

--------------------------------

### Example implementation for um_admin_user_action_hook

Source: https://docs.ultimatemember.com/article/1004-umadminuseractionhook

Provides a complete PHP example that registers a custom function for the um_admin_user_action_hook and defines the callback. The callback receives the $subaction string parameter.

```php
<?php
add_action( 'um_admin_user_action_hook', 'my_admin_user_action', 10, 1 );
function my_admin_user_action( $subaction ) {
    // your code here
}
?>
```

--------------------------------

### Example callback for um_account_secure_fields

Source: https://docs.ultimatemember.com/article/965-umaccountsecurefields

Example implementation of the filter. The callback receives the account fields array and the user ID, and must return the modified fields array.

```php
<?php
add_filter( 'um_account_secure_fields', 'my_account_secure_fields', 10, 2 );
function my_account_secure_fields( $fields, $id ) {
    // your code here
return $fields;
}
?>
```

--------------------------------

### Example of um_theme_after_page_content Hook

Source: https://docs.ultimatemember.com/article/1434-umthemeafterpagecontent

Provides a complete example of adding a custom function to the um_theme_after_page_content action hook.

```php
<?php
add_action( 'um_theme_after_page_content', 'my_theme_post' );

function my_theme_post() { 
	// your code here;
 } 
?>
```

--------------------------------

### Example callback for um_admin_settings_email_section_fields

Source: https://docs.ultimatemember.com/article/1003-umadminsettingsemailsectionfields

Example implementation of the filter callback that receives the settings array and email key, and returns the modified settings.

```php
<?php
add_filter( 'um_admin_settings_email_section_fields', 'my_admin_settings_email_section', 10, 2 );
function my_admin_settings_email_section( $settings, $email_key ) {
    // your code here
return $settings;
}
?>
```

--------------------------------

### Example implementation of um_access_fix_external_post_content

Source: https://docs.ultimatemember.com/article/958-umaccessfixexternalpostcontent

Example of defining a callback function for the hook. The function is empty and ready for custom code.

```php
<?php
add_action( 'um_access_fix_external_post_content', 'my_access_fix_external_post_content', 10 );
function my_access_fix_external_post_content() {
    // your code here
}
?>
```

--------------------------------

### Example implementation for um_custom_image_handle_{$field}

Source: https://docs.ultimatemember.com/article/1097-umcustomimagehandlefield

Example implementation of a callback for the um_custom_image_handle_{$field} filter. The function receives $data and returns it after custom processing.

```php
<?php
add_filter( 'um_custom_image_handle_{$field}', 'my_custom_image_handle', 10, 1 );
function my_custom_image_handle( $data ) {
    // your code here
return $data;
}
?>
```

--------------------------------

### Example: um_theme_after_comments_title callback with function definition

Source: https://docs.ultimatemember.com/article/1428-umthemebelowcommentstitle

Complete example that hooks my_comments_title to um_theme_after_comments_title and defines the callback with a placeholder comment for custom code.

```php
<?php
add_action( 'um_theme_after_comments_title', 'my_comments_title' );

function my_comments_title() { 
	// your code here;
 } 
?>
```

--------------------------------

### Example: custom callback for um_update_profile_full_name

Source: https://docs.ultimatemember.com/article/1285-umupdateprofilefullname

Example of a custom callback function hooked to um_update_profile_full_name. The function receives $user_id and $args, and contains a placeholder for custom code.

```php
<?php
add_action( 'um_update_profile_full_name', 'my_update_profile_full_name', 10, 2 );
function my_update_profile_full_name( $user_id, $args ) {
    // your code here
}
?>
```

--------------------------------

### Example callback for um_after_template_part

Source: https://docs.ultimatemember.com/article/1027-umaftertemplatepart

Example callback function that receives the template name, path, located file, and template arguments. Place custom code inside the function body.

```php
<?php
add_action( 'um_after_template_part', 'my_after_template_part', 10, 4 );
function my_after_template_part( $template_name, $path, $located, $t_args ) {
    // your code here
}
?>
```

--------------------------------

### Example: Custom callback for um_access_enable_referer

Source: https://docs.ultimatemember.com/article/957-umaccessenablereferer

Provides a complete PHP example of adding a custom function to the um_access_enable_referer filter. The function receives the $referrer boolean and returns it after custom logic.

```php
<?php
add_filter( 'um_access_enable_referer', 'my_access_enable_referer', 10, 1 );
function my_access_enable_referer( $referrer ) {
    // your code here
return $referrer;
}
?>
```

--------------------------------

### Implement my_admin_field_modal_footer callback

Source: https://docs.ultimatemember.com/article/994-umadminfieldmodalfooter

Example implementation of the callback function for the um_admin_field_modal_footer hook.

```php
<?php
add_action( 'um_admin_field_modal_footer', 'my_admin_field_modal_footer', 10, 4 );
function my_admin_field_modal_footer( $arg2, $args, $in_edit, $edit_array ) {
    // your code here
}
?>
```

--------------------------------

### Example usage of um_roles_add_meta_boxes hook

Source: https://docs.ultimatemember.com/article/1249-umrolesaddmetaboxes

Example implementation of the um_roles_add_meta_boxes action hook. The callback function receives the $meta parameter and can contain custom code to add meta boxes on the add/edit UM Role screen.

```php
<?php
add_action( 'um_roles_add_meta_boxes', 'my_roles_add_meta_boxes', 10, 1 );
function my_roles_add_meta_boxes( $meta ) {
    // your code here
}
?>
```

--------------------------------

### Example implementation of um_rest_api_get_stats filter

Source: https://docs.ultimatemember.com/article/1243-umrestapigetstats

Provides a complete example of a custom filter function that modifies the $response array. The function returns the modified $response. This example is intended for developers to customize the Rest API get stats output.

```php
<?php
add_filter( 'um_rest_api_get_stats', 'my_rest_api_get_stats', 10, 1 );
function my_rest_api_get_stats( $response ) {
    // your code here
return $response;
}
?>
```

--------------------------------

### Example implementation of um_modify_sortby_parameter

Source: https://docs.ultimatemember.com/article/1179-ummodifysortbyparameter

Example function that modifies the query arguments for the Members Directory sort by parameter.

```php
<?php
add_filter( 'um_modify_sortby_parameter', 'my_modify_sortby_parameter', 10, 2 );
function my_modify_sortby_parameter( $query_args, $sortby ) {
    // your code here
return $query_args;
}
?>
```

--------------------------------

### Example: Retrieve and echo user IP with um_user_ip()

Source: https://docs.ultimatemember.com/article/159-umuserip

Retrieves the user's IP address and prints it with a message. The output is the IP address, e.g., 127.0.0.1.

```php
<?php
$user_ip = um_user_ip();
echo 'User IP address is: ' . $user_ip; 
// prints the user IP address e.g. 127.0.0.1
?>

```

--------------------------------

### Example 02: Allow video file uploads

Source: https://docs.ultimatemember.com/article/1045-umallowedfiletypes

Adds video file extensions to the allowed types and embeds video files in profile view. Requires adding to functions.php. Uses wp_get_video_extensions() and applies the [video] shortcode.

```php
<?php  

/**  
 * Allow to upload video files via the "File Upload" field type.  
 * Add this code to the file functions.php in the active theme directory.  
 */  
add_filter( 'um_allowed_file_types', 'um_add_video_file_types' );  
add_filter( 'um_profile_field_filter_hook__file', 'um_profile_field_filter_hook__file_video', 101, 2 );  

/**  
 * Extend "Allowed File Types" in the File Upload field.  
 *  
 * @param array $allowed_types List of supported formats.  
 * @return array  
 */  
function um_add_video_file_types( $allowed_types ) {  
	$video_file_types = array();  
	foreach( wp_get_video_extensions() as $ext ) {  
		$video_file_types[ $ext ] = strtoupper( $ext ) . ' video';  
	}  
	return array_merge( $video_file_types, (array) $allowed_types );  
}  

/**  
 * Embed video files and play them in profile view.  
 *  
 * @param string $value Field Value.  
 * @param array $data Field Data.  
 * @return string  
 */  
function um_profile_field_filter_hook__file_video( $value, $data ) {  
	$filename = um_user( $data['metakey'] );  
	$fileinfo = um_user( $data['metakey'] . '_metadata' );  
	if ( $filename && is_array( $fileinfo ) && in_array( $fileinfo['ext'], wp_get_video_extensions(), true ) ) {  
		$file_url = trailingslashit( UM()->uploader()->get_upload_user_base_url( um_profile_id() ) ) . $filename;  
		$shortcode = '[video src="' . esc_url( $file_url ) . '"]';  
		$value = apply_shortcodes( $shortcode );  
	}  
	return $value;  
}  

```

--------------------------------

### Example implementation of um_edit_{$key}_field_value

Source: https://docs.ultimatemember.com/article/1109-umeditkeyfieldvalue

A complete example showing how to define the callback function to modify the field value.

```php
<?php
add_filter( 'um_edit_{$key}_field_value', 'my_edit_field_value', 10, 2 );
function my_edit_field_value( $value, $key ) {
    // your code here
return $value;
}
?>
```

--------------------------------

### Example implementation of um_profile_header hook

Source: https://docs.ultimatemember.com/article/1212-umprofileheader

Defines a custom function my_profile_header that hooks into um_profile_header and receives the $args array.

```php
<?php
add_action( 'um_profile_header', 'my_profile_header', 10, 1 );
function my_profile_header( $args ) {
    // your code here
}
?>
```

--------------------------------

### Auto-login user with remember session using UM()->user()->auto_login(10, true)

Source: https://docs.ultimatemember.com/article/161-autologin

Example that signs in a user and makes the plugin remember their session by passing true for the $rememberme parameter.

```php
 <?php UM()->user()->auto_login ( 10, true ); ?>

```

--------------------------------

### Example usage of um_view_field_value_{$type} filter

Source: https://docs.ultimatemember.com/article/1316-umviewfieldvaluetype

Example implementation of the um_view_field_value_{$type} filter. The callback function my_form_edit_field receives the field HTML and data, and must return the modified HTML. Note the function name in the example differs from the one in the add_filter call.

```php
<?php
add_filter( 'um_view_field_value_{$type}', 'my_view_field', 10, 2 );
function my_form_edit_field( $output, $data ) {
    // your code here
return $output;
}
?>
```

--------------------------------

### Implement my_after_user_updated callback

Source: https://docs.ultimatemember.com/article/1038-umafteruserupdated

Example implementation of the callback function to handle user profile updates.

```php
<?php
add_action( 'um_after_user_updated', 'my_after_user_updated', 10, 3 );
function my_after_user_updated( $user_id, $args, $userinfo ) {
    // your code here
}
?>
```

--------------------------------

### Implement the um_profile_menu_link_{$id} callback

Source: https://docs.ultimatemember.com/article/1215-umprofilemenulinkid

Example implementation of the callback function to modify the navigation link.

```php
<?php
add_filter( 'um_profile_menu_link_{$id}', 'my_profile_menu_link', 10, 1 );
function my_profile_menu_link( $nav_link ) {
    // your code here
return $nav_link;
}
?>
```

--------------------------------

### Example: Custom callback for um_validation_safe_username_regex

Source: https://docs.ultimatemember.com/article/1313-umvalidationsafeusernameregex

Example implementation of a callback function for the um_validation_safe_username_regex filter. The function receives the $regex_safe parameter and returns it after modification.

```php
<?php
add_filter( 'um_validation_safe_username_regex', 'my_validation_safe_username', 10, 1 );
function my_validation_safe_username( $regex_safe ) {
    // your code here
return $regex_safe;
}
?>
```

--------------------------------

### Registering the um_user_before_query hook

Source: https://docs.ultimatemember.com/article/1292-umuserbeforequery

Basic syntax for adding an action to the um_user_before_query hook.

```php
add_action( 'um_user_before_query', 'function_name', 10, 1 );
```

--------------------------------

### Example implementation of um_{$key}_form_edit_field

Source: https://docs.ultimatemember.com/article/1321-umkeyformeditfield

Example callback function that modifies the field HTML. The function receives $output and $mode, and should return the modified $output.

```php
<?php
add_filter( 'um_{$key}_form_edit_field', 'my_form_edit_field', 10, 2 );
function my_form_edit_field( $output, $mode ) {
    // your code here
return $output;
}
?>
```
Tokens:
Raw