Classes
UM_Extended
final
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Constants
This class has not constants.
Methods
Call function
public function __call( string $name, array $arguments ) : void
Parameter | Type(s) | Description |
---|---|---|
$name | string | Function name. |
$arguments | array | Function args. |
Main UM_Extended Instance
public static function instance( ) : \UM
Description:
Ensures only one instance of UM is loaded or can be loaded.
Since | v1.0 |
See also | \UM() |
Returns:
- Main instance
Dynamically load extensions.
public function um_extended_construct( ) : void
Description:
Directory name and class should match patterns: e.g. directory 'um-user-shortcode' should have a class UM_Extended_User_Shortcode
Inherited methods
This class has not inherited methods.
Properties
Inherited properties
This class has not inherited properties.
UM_Extended_API
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v2.0.0 |
Constants
This class has not constants.
Methods
Adds the RefreshRuntime.
public function dev_refresh_runtime( ) : void
Since | v2.0.0 |
Return the dev URL.
private function get_dev_url( ) : string
Since | v4.1.9 |
Returns:
The dev URL.
Get the manifest to load assets from.
private function get_manifest( ) : array
Since | v4.1.9 |
Returns:
An array of files.
Get the JS asset handle.
public function js_handle( string $asset = '' ) : string
Parameter | Type(s) | Description |
---|---|---|
$asset optional | string | The asset to find the handle for. |
Since | v2.0.0 |
Returns:
The asset handle.
Preload JS imports.
private function js_preload_imports( string $url ) : void
Parameter | Type(s) | Description |
---|---|---|
$url | string | The asset to load imports for. |
Since | v2.0.0 |
Live Plugin URL
public function live_url( string $asset ) : void
Parameter | Type(s) | Description |
---|---|---|
$asset | string | Asset name. |
Since | v2.0.0 |
Load Asset from Manifest
public function load_manifest( string $asset, boolean $css_dependencies = false ) : void
Parameter | Type(s) | Description |
---|---|---|
$asset | string | The asset name. |
$css_dependencies optional | boolean | Whether dependencies are CSS. |
Register the JS to enqueue.
public function register_js( string $asset, array $dependencies = array(), mixed $data = null, string $object_name = 'um_extended' ) : void
Parameter | Type(s) | Description |
---|---|---|
$asset | string | The script to load. |
$dependencies optional | array | An array of dependencies. |
$data optional | mixed | Any data to be localized. |
$object_name optional | string | The object name to use when localizing. |
Since | v2.0.0 |
Register the CSS to enqueue.
public function register_styles( string $asset, string $handle ) : void
Parameter | Type(s) | Description |
---|---|---|
$asset | string | The script to load. |
$handle | string | Handle name. |
Since | v2.0.0 |
Filter the script loader tag if this is our script.
public function script_loader_tag( string $tag, string $handle = '', string $src = '' ) : string
Parameter | Type(s) | Description |
---|---|---|
$tag | string | The tag that is going to be output. |
$handle optional | string | The handle for the script. |
$src optional | string | The source. |
Since | v4.1.9 |
Returns:
The modified tag.
Inherited methods
This class has not inherited methods.
Properties
Inherited properties
This class has not inherited properties.
UM_WPCLI\Commands\Developer
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Init
public function __construct( string $file = null ) : void
Parameter | Type(s) | Description |
---|---|---|
$file optional | string | Filename. |
Create core file
public function create_core_files( string $namespace, string $directory, string $root_plugin_dir, string $plugin_root_dir ) : void
Parameter | Type(s) | Description |
---|---|---|
$namespace | string | Namespace. |
$directory | string | Directory path. |
$root_plugin_dir | string | Root Plugin directory. |
$plugin_root_dir | string | Plugin roo directory without path. |
Scaffold
public function handle( string $namespace, string $directory, string $output = 'composer.json' ) : void
Parameter | Type(s) | Description |
---|---|---|
$namespace | string | Namespace. |
$directory | string | Directory source. |
$output optional | string | File output. |
Create Scaffold Command: wp um dev scaffold <namespace>
public function scaffold( array $args, array $assoc_args ) : void
Parameter | Type(s) | Description |
---|---|---|
$args | array | Command arguments. |
$assoc_args | array | Associated arguments. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_WPCLI\Commands\Stripe
Class Stripe to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Block_Emails\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
API_URL
CDN API URL
API_URL = 'https://rawcdn.githack.com/disposable/disposable-email-domains/master/domains.json';
Type: mixed
Methods
Init
public function __construct( string $file ) : void
Parameter | Type(s) | Description |
---|---|---|
$file | string | Name of the File. |
Since | v1.0.0 |
Merge Disposble Emails with Blocked Emails
public function merge_disposable_emails( string $emails ) : void
Parameter | Type(s) | Description |
---|---|---|
$emails | string | Existing emails. |
Sync list on plugin activation
public function plugin_activation( ) : void
Since | v1.0.0 |
Update Disposable Email Providers
public function update_blacklist( ) : void
Since | v1.0.0 |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Browser_Detect\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Add Predefined fields
public function add_predefined_fields( array $predefined_fields ) : array
Parameter | Type(s) | Description |
---|---|---|
$predefined_fields | array | Predefined fields. |
Since | v1.0.0 |
Returns:
$predefined_fields
render_hidden_field ( )
Render Hidden Field
public function render_hidden_field( string $output, array $data ) : string
Parameter | Type(s) | Description |
---|---|---|
$output | string | HTML output. |
$data | array | Field Data. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Capitalize_Name\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Apply capitlization to the Display Name globally
public function apply_capitalization( string $name ) : \UM_Extended_Capitalize_Name\string`
Parameter | Type(s) | Description |
---|---|---|
$name | string | Name of a User. |
Since | v1.0.0 |
Adds Display Name in the column
public function column_content( string $value, string $column_name, integer $user_id ) : string
Parameter | Type(s) | Description |
---|---|---|
$value | string | Column value. |
$column_name | string | Column name. |
$user_id | integer | the user ID in the loop. |
Since | v1.0.0 |
Returns:
$value modified value.
Adds Custom Column To Users List Table
public function display_name_column( array $columns ) : void
Parameter | Type(s) | Description |
---|---|---|
$columns | array | User table columns. |
Validate Names with different cases
public function validate_names( string $name, string $encoding = 'UTF-8' ) : string
Parameter | Type(s) | Description |
---|---|---|
$name | string | Name. |
$encoding optional | string | String encoding. |
Since | v1.0.0 |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Country_Flag\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Cover_Photo\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
delete_cover_photo_from_account ( )
Delete cover photo via the account form
public function delete_cover_photo_from_account( ) : void
field_settings_type_min_height ( )
Min Height field option
public function field_settings_type_min_height( string $edit_mode_value ) : void
Parameter | Type(s) | Description |
---|---|---|
$edit_mode_value | string | Field value. |
field_settings_type_min_width ( )
Min Width field option
public function field_settings_type_min_width( string $edit_mode_value ) : void
Parameter | Type(s) | Description |
---|---|---|
$edit_mode_value | string | Field value. |
Add columns in field settings
public function modify_field_option( array $fields ) : array
Parameter | Type(s) | Description |
---|---|---|
$fields | array | Field settings. |
Returns:
$fields
Change filename
public function photo_name( string $dir, string $filename, string $ext ) : void
Parameter | Type(s) | Description |
---|---|---|
$dir | string | Directory name. |
$filename | string | Uploading file name. |
$ext | string | Extension of the uploading file. |
Add new predefined field "Cover Photo" in UM Form Builder.
public function predefined_fields( array $arr ) : void
Parameter | Type(s) | Description |
---|---|---|
$arr | array | field array settings. |
Multiply Cover Photo with different sizes
public function set_cover_photo( integer $user_id, array $args ) : void
Parameter | Type(s) | Description |
---|---|---|
$user_id | integer | the user ID. |
$args | array | Field settings. |
um_user_pre_updating_files_array ( )
Remove cover photo field from the default uploader for Profile forms
public function um_user_pre_updating_files_array( array $files ) : array
Parameter | Type(s) | Description |
---|---|---|
$files | array | Files. |
Returns:
$files
Set handler callback for filename
public function upload_handler( array $override_handler ) : void
Parameter | Type(s) | Description |
---|---|---|
$override_handler | array | WP Media uploader handler. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Cron_Delete\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
delete_users_awaiting_email ( )
Delete Users awating email
public function delete_users_awaiting_email( ) : void
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Cronjob_Activation_Email\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Resend email confirmation link to those users with expired secret hash
public function resend_activation_notify( ) : void
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Dummy_Accounts\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Admin Form hook
public function admin_addon_hook( string $hook ) : void
Parameter | Type(s) | Description |
---|---|---|
$hook | string | Form hook. |
Inherited methods
This class has not inherited methods.
Properties
Inherited properties
This class has not inherited properties.
UM_Extended_Fields_Counter\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Add field attributes
public function field_length_limit( array $field_atts, string $key, array $data ) : void
Parameter | Type(s) | Description |
---|---|---|
$field_atts | array | Field attributes. |
$key | string | Field key / meta key. |
$data | array | Field data. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Math_Captcha\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Validate Captcha
public function validate( array $post_form ) : void
Parameter | Type(s) | Description |
---|---|---|
$post_form | array | Form data. |
Inherited methods
This class has not inherited methods.
Properties
Inherited properties
This class has not inherited properties.
UM_Extended_Pass_Strength\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Profile_Photo\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
delete_profile_photo_from_account ( )
Delete Profile Photo via the account form
public function delete_profile_photo_from_account( ) : void
field_settings_type_min_height ( )
Min Height field option
public function field_settings_type_min_height( string $edit_mode_value ) : void
Parameter | Type(s) | Description |
---|---|---|
$edit_mode_value | string | Field value. |
field_settings_type_min_width ( )
Min Width field option
public function field_settings_type_min_width( string $edit_mode_value ) : void
Parameter | Type(s) | Description |
---|---|---|
$edit_mode_value | string | Field value. |
Add columns in field settings
public function modify_field_option( array $fields ) : array
Parameter | Type(s) | Description |
---|---|---|
$fields | array | Field settings. |
Returns:
$fields
Change filename
public function photo_name( string $dir, string $filename, string $ext ) : void
Parameter | Type(s) | Description |
---|---|---|
$dir | string | Directory name. |
$filename | string | Uploading file name. |
$ext | string | Extension of the uploading file. |
Add new predefined field "Profile Photo" in UM Form Builder.
public function predefined_fields( array $arr ) : void
Parameter | Type(s) | Description |
---|---|---|
$arr | array | field array settings. |
Multiply Profile Photo with different sizes
public function set_profile_photo( integer $user_id, array $args ) : void
Parameter | Type(s) | Description |
---|---|---|
$user_id | integer | the user ID. |
$args | array | Field settings. |
um_user_pre_updating_files_array ( )
Remove Profile Photo field from the default uploader for Profile forms
public function um_user_pre_updating_files_array( array $files ) : array
Parameter | Type(s) | Description |
---|---|---|
$files | array | Files. |
Returns:
$files
Set handler callback for filename
public function upload_handler( array $override_handler ) : void
Parameter | Type(s) | Description |
---|---|---|
$override_handler | array | WP Media uploader handler. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Profile_slug\Enqueue
Class Enqueue to handle all plugin initialization.
Extends | \ |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Profile_Slug\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Modify Profile URLs
public function profile_page_link( string $permalink, integer $post_id ) : void
Parameter | Type(s) | Description |
---|---|---|
$permalink | string | Permalink. |
$post_id | integer | Post ID. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Regenerate_Thumbnails\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Inherited methods
This class has not inherited methods.
Properties
Inherited properties
This class has not inherited properties.
UM_Extended_Set_Password\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
add_email_template_placeholder ( )
Add set password placeholder tag
public function add_email_template_placeholder( array $placeholders ) : void
Parameter | Type(s) | Description |
---|---|---|
$placeholders | array | Placeholder array. |
change_password_set_message ( )
Add custom message for Login
public function change_password_set_message( string $success, string $key ) : void
Parameter | Type(s) | Description |
---|---|---|
$success | string | Success Message. |
$key | string | Message key. |
Redirect with parameter to set Password text
public function password_has_changed( integer $user_id ) : void
Parameter | Type(s) | Description |
---|---|---|
$user_id | integer | User ID. |
set_password_add_replace_placeholder ( )
Generate set password link for placeholder
public function set_password_add_replace_placeholder( array $replace_placeholders ) : void
Parameter | Type(s) | Description |
---|---|---|
$replace_placeholders | array | . |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_User_Shortcode\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Returns a user meta value Usage [um_user user_id="" meta_key="" ] // leave user_id empty if you want to retrive the current user's meta value.
public function shortcode( array $atts ) : void
Parameter | Type(s) | Description |
---|---|---|
$atts | array | shortcode attributes. |
Description:
meta_key is the field name that you've set in the UM form builder You can modify the return meta_value with filter hook 'um_user_shortcode_filter__{$meta_key}'
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Vcard\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Add Vcard predefined field.
public function add_field( array $fields ) : void
Parameter | Type(s) | Description |
---|---|---|
$fields | array | predefined fields array. |
Don't remove the vcard.vcf file from the members' folder.
public function block_removing( boolean $can_unlink, integer $user_id, string $str ) : boolean
Parameter | Type(s) | Description |
---|---|---|
$can_unlink | boolean | Can unlink or not. |
$user_id | integer | User ID. |
$str | string | File name. |
See also | \um\core\Uploader::remove_unused_uploads() |
Generate VCard on profile update
public function generate( integer $user_id ) : void
Parameter | Type(s) | Description |
---|---|---|
$user_id | integer | The current user's ID. |
Image Encode
public function image_encode( string $path ) : string
Parameter | Type(s) | Description |
---|---|---|
$path | string | Vcard File path. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_Extended_Yoast_Seo\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Change author URLs to UM Profile URLs in Author archive sitemap
public function author_link( string $link, integer $author_id, string $author_nicename ) : void
Parameter | Type(s) | Description |
---|---|---|
$link | string | Author Link. |
$author_id | integer | Author ID. |
$author_nicename | string | Author Name. |
change_opengraph_image_url ( )
Change Twitter/Open Graph Image URL
public function change_opengraph_image_url( string $url ) : void
Parameter | Type(s) | Description |
---|---|---|
$url | string | Open Graph Image URL. |
Change Open Graph Type to Profile
public function change_opengraph_type( string $type ) : void
Parameter | Type(s) | Description |
---|---|---|
$type | string | Open Graph Type. |
Change OpenGraph/Twitter Title to UM Profile Title.
public function opengraph_title( string $name ) : void
Parameter | Type(s) | Description |
---|---|---|
$name | string | Open graph title. |
Description:
Go to UM > Settings > Misc > see "User Profile Title" & "User Profile Dynamic Meta Description"
Change Open Graph URL to UM Profile URL
public function opengraph_url( string $url ) : void
Parameter | Type(s) | Description |
---|---|---|
$url | string | Open Graph URL. |
Add extra meta tags not available from Yoast SEO to the User Profile Page
public function profile_dynamic_meta_desc( ) : void
Add all UM Profiles to Author archive sitemap
public function sitemap_exclude_author( array $users ) : void
Parameter | Type(s) | Description |
---|---|---|
$users | array | Users. |
um_custom_wpseo_opengraph_site ( )
Change Twitter site/creator account to UM field twitter value
public function um_custom_wpseo_opengraph_site( string $site ) : void
Parameter | Type(s) | Description |
---|---|---|
$site | string | Site creator/account. |
Change canonical URL to UM Profile URL
public function user_yoast_canonical( string $url ) : string
Parameter | Type(s) | Description |
---|---|---|
$url | string | Canonical URL. |
Returns:
$url
Get twitter ID from string URL
public function wpseo_get_twitter_id( string $id ) : string
Parameter | Type(s) | Description |
---|---|---|
$id | string | Twitter ID. |
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.
UM_WPCLI\Core
Class Core to handle all plugin initialization.
Extends | Nothing |
Implements | Nothing |
Uses | Nothing |
Since | v1.0.0 |
Constants
This class has not constants.
Methods
Inherited methods
This class has not inherited methods.
Properties
This class has not properties.
Inherited properties
This class has not inherited properties.