account_activation_link_tags_patterns()
account_activation_link_tags_patterns( $placeholders) : array
UM Placeholders for activation link in email
Parameters
| $placeholders |
| Action_Scheduler |
| um |
| ActionScheduler_Exception | ActionScheduler Exception Interface. |
| ActionScheduler_Schedule | Class ActionScheduler_Schedule |
| CronExpression_FieldInterface | CRON field interface |
| ActionScheduler | Class ActionScheduler |
| ActionScheduler_Abstract_ListTable | Action Scheduler Abstract List Table class |
| ActionScheduler_Abstract_QueueRunner | Abstract class with common Queue Cleaner functionality. |
| ActionScheduler_Abstract_QueueRunner_Deprecated | Abstract class with common Queue Cleaner functionality. |
| ActionScheduler_Abstract_RecurringSchedule | Class ActionScheduler_Abstract_RecurringSchedule |
| ActionScheduler_Abstract_Schedule | Class ActionScheduler_Abstract_Schedule |
| ActionScheduler_Abstract_Schema | Class ActionScheduler_Abstract_Schema |
| ActionScheduler_Action | Class ActionScheduler_Action |
| ActionScheduler_ActionClaim | Class ActionScheduler_ActionClaim |
| ActionScheduler_ActionFactory | Class ActionScheduler_ActionFactory |
| ActionScheduler_AdminView | Class ActionScheduler_AdminView |
| ActionScheduler_AdminView_Deprecated | Class ActionScheduler_AdminView_Deprecated |
| ActionScheduler_AsyncRequest_QueueRunner | ActionScheduler_AsyncRequest_QueueRunner class. |
| ActionScheduler_CanceledAction | Class ActionScheduler_CanceledAction |
| ActionScheduler_CanceledSchedule | Class ActionScheduler_SimpleSchedule |
| ActionScheduler_Compatibility | Class ActionScheduler_Compatibility |
| ActionScheduler_CronSchedule | Class ActionScheduler_CronSchedule |
| ActionScheduler_DataController | Class ActionScheduler_DataController |
| ActionScheduler_DateTime | ActionScheduler DateTime class. |
| ActionScheduler_DBLogger | Class ActionScheduler_DBLogger |
| ActionScheduler_DBStore | Class ActionScheduler_DBStore |
| ActionScheduler_DBStoreMigrator | Class ActionScheduler_DBStoreMigrator |
| ActionScheduler_FatalErrorMonitor | Class ActionScheduler_FatalErrorMonitor |
| ActionScheduler_FinishedAction | Class ActionScheduler_FinishedAction |
| ActionScheduler_HybridStore | Class ActionScheduler_HybridStore |
| ActionScheduler_IntervalSchedule | Class ActionScheduler_IntervalSchedule |
| ActionScheduler_InvalidActionException | InvalidAction Exception. |
| ActionScheduler_ListTable | Implements the admin view of the actions. |
| ActionScheduler_Lock | Abstract class for setting a basic lock to throttle some action. |
| ActionScheduler_LogEntry | Class ActionScheduler_LogEntry |
| ActionScheduler_Logger | Class ActionScheduler_Logger |
| ActionScheduler_LoggerSchema | Class ActionScheduler_LoggerSchema |
| ActionScheduler_NullAction | Class ActionScheduler_NullAction |
| ActionScheduler_NullLogEntry | Class ActionScheduler_NullLogEntry |
| ActionScheduler_NullSchedule | Class ActionScheduler_NullSchedule |
| ActionScheduler_OptionLock | Provide a way to set simple transient locks to block behaviour for up-to a given duration. |
| ActionScheduler_QueueCleaner | Class ActionScheduler_QueueCleaner |
| ActionScheduler_QueueRunner | Class ActionScheduler_QueueRunner |
| ActionScheduler_Schedule_Deprecated | Class ActionScheduler_Abstract_Schedule |
| ActionScheduler_SimpleSchedule | Class ActionScheduler_SimpleSchedule |
| ActionScheduler_Store | Class ActionScheduler_Store |
| ActionScheduler_Store_Deprecated | Class ActionScheduler_Store_Deprecated |
| ActionScheduler_StoreSchema | Class ActionScheduler_StoreSchema |
| ActionScheduler_TimezoneHelper | Class ActionScheduler_TimezoneHelper |
| ActionScheduler_Versions | Class ActionScheduler_Versions |
| ActionScheduler_wcSystemStatus | Class ActionScheduler_wcSystemStatus |
| ActionScheduler_WPCLI_Clean_Command | Commands for Action Scheduler. |
| ActionScheduler_WPCLI_QueueRunner | WP CLI Queue runner. |
| ActionScheduler_WPCLI_Scheduler_command | Commands for Action Scheduler. |
| ActionScheduler_WPCommentCleaner | Class ActionScheduler_WPCommentCleaner |
| ActionScheduler_wpCommentLogger | Class ActionScheduler_wpCommentLogger |
| ActionScheduler_wpPostStore | Class ActionScheduler_wpPostStore |
| ActionScheduler_wpPostStore_PostStatusRegistrar | Class ActionScheduler_wpPostStore_PostStatusRegistrar |
| ActionScheduler_wpPostStore_PostTypeRegistrar | Class ActionScheduler_wpPostStore_PostTypeRegistrar |
| ActionScheduler_wpPostStore_TaxonomyRegistrar | Class ActionScheduler_wpPostStore_TaxonomyRegistrar |
| Array2XML | |
| CronExpression | CRON expression parser that can determine whether or not a CRON expression is due to run, the next run date and previous run date of a CRON expression. |
| CronExpression_AbstractField | Abstract CRON expression field |
| CronExpression_DayOfMonthField | Day of month field. Allows: * , / - ? L W |
| CronExpression_DayOfWeekField | Day of week field. Allows: * / , - ? L # |
| CronExpression_FieldFactory | CRON field factory implementing a flyweight factory |
| CronExpression_HoursField | Hours field. Allows: * , / - |
| CronExpression_MinutesField | Minutes field. Allows: * , / - |
| CronExpression_MonthField | Month field. Allows: * , / - |
| CronExpression_YearField | Year field. Allows: * , / - |
| UM_Emails_List_Table | Class UM_Emails_List_Table |
| UM_Functions | Class UM_Functions |
| UM_Roles_List_Table | Class UM_Roles_List_Table |
| UM_Versions_List_Table | Class UM_Versions_List_Table |
| WP_Async_Request | Abstract WP_Async_Request class. |
as_enqueue_async_action(string $hook, array $args = array(), string $group = '', bool $unique = false, int $priority = 10) : int
Enqueue an action to run one time, as soon as possible
| string | $hook | The hook to trigger. |
| array | $args | Arguments to pass when the hook triggers. |
| string | $group | The group to assign this job to. |
| bool | $unique | Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. |
| int | $priority | Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. |
The action ID. Zero if there was an error scheduling the action.
as_get_datetime_object(mixed $date_string = null, string $timezone = 'UTC') : \ActionScheduler_DateTime
Helper function to create an instance of DateTime based on a given string and timezone. By default, will return the current date/time in the UTC timezone.
Needed because new DateTime() called without an explicit timezone will create a date/time in PHP's timezone, but we need to have assurance that a date/time uses the right timezone (which we almost always want to be UTC), which means we need to always include the timezone when instantiating datetimes rather than leaving it up to the PHP default.
| mixed | $date_string | A date/time string. Valid formats are explained in http://php.net/manual/en/datetime.formats.php. |
| string | $timezone | A timezone identifier, like UTC or Europe/Lisbon. The list of valid identifiers is available http://php.net/manual/en/timezones.php. |
as_get_scheduled_actions(array $args = array(), string $return_format = OBJECT) : array
Find scheduled actions
| array | $args | Possible arguments, with their default values. 'hook' => '' - the name of the action that will be triggered. 'args' => NULL - the args array that will be passed with the action. 'date' => NULL - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. 'date_compare' => '<=' - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '='. 'modified' => NULL - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. 'modified_compare' => '<=' - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '='. 'group' => '' - the group the action belongs to. 'status' => '' - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING. 'claimed' => NULL - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID. 'per_page' => 5 - Number of results to return. 'offset' => 0. 'orderby' => 'date' - accepted values are 'hook', 'group', 'modified', 'date' or 'none'. 'order' => 'ASC'. |
| string | $return_format | OBJECT, ARRAY_A, or ids. |
as_has_scheduled_action(string $hook, array $args = null, string $group = '') : bool
Check if there is a scheduled action in the queue but more efficiently than as_next_scheduled_action().
It's recommended to use this function when you need to know whether a specific action is currently scheduled (pending or in-progress).
| string | $hook | The hook of the action. |
| array | $args | Args that have been passed to the action. Null will matches any args. |
| string | $group | The group the job is assigned to. |
True if a matching action is pending or in-progress, false otherwise.
as_next_scheduled_action(string $hook, array $args = null, string $group = '') : int|bool
Check if there is an existing action in the queue with a given hook, args and group combination.
An action in the queue could be pending, in-progress or async. If the is pending for a time in future, its scheduled date will be returned as a timestamp. If it is currently being run, or an async action sitting in the queue waiting to be processed, in which case boolean true will be returned. Or there may be no async, in-progress or pending action for this hook, in which case, boolean false will be the return value.
| string | $hook | Name of the hook to search for. |
| array | $args | Arguments of the action to be searched. |
| string | $group | Group of the action to be searched. |
The timestamp for the next occurrence of a pending scheduled action, true for an async or in-progress action or false if there is no matching action.
as_schedule_cron_action(int $timestamp, string $schedule, string $hook, array $args = array(), string $group = '', bool $unique = false, int $priority = 10) : int
Schedule an action that recurs on a cron-like schedule.
| int | $timestamp | The first instance of the action will be scheduled to run at a time calculated after this timestamp matching the cron expression. This can be used to delay the first instance of the action. |
| string | $schedule | A cron-link schedule string. |
| string | $hook | The hook to trigger. |
| array | $args | Arguments to pass when the hook triggers. |
| string | $group | The group to assign this job to. |
| bool | $unique | Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. |
| int | $priority | Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. |
The action ID. Zero if there was an error scheduling the action.
as_schedule_recurring_action(int $timestamp, int $interval_in_seconds, string $hook, array $args = array(), string $group = '', bool $unique = false, int $priority = 10) : int
Schedule a recurring action
| int | $timestamp | When the first instance of the job will run. |
| int | $interval_in_seconds | How long to wait between runs. |
| string | $hook | The hook to trigger. |
| array | $args | Arguments to pass when the hook triggers. |
| string | $group | The group to assign this job to. |
| bool | $unique | Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. |
| int | $priority | Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. |
The action ID. Zero if there was an error scheduling the action.
as_schedule_single_action(int $timestamp, string $hook, array $args = array(), string $group = '', bool $unique = false, int $priority = 10) : int
Schedule an action to run one time
| int | $timestamp | When the job will run. |
| string | $hook | The hook to trigger. |
| array | $args | Arguments to pass when the hook triggers. |
| string | $group | The group to assign this job to. |
| bool | $unique | Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. |
| int | $priority | Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. |
The action ID. Zero if there was an error scheduling the action.
as_unschedule_action(string $hook, array $args = array(), string $group = '') : int|null
Cancel the next occurrence of a scheduled action.
While only the next instance of a recurring or cron action is unscheduled by this method, that will also prevent all future instances of that recurring or cron action from being run. Recurring and cron actions are scheduled in a sequence instead of all being scheduled at once. Each successive occurrence of a recurring action is scheduled only after the former action is run. If the next instance is never run, because it's unscheduled by this function, then the following instance will never be scheduled (or exist), which is effectively the same as being unscheduled by this method also.
| string | $hook | The hook that the job will trigger. |
| array | $args | Args that would have been passed to the job. |
| string | $group | The group the job is assigned to. |
The scheduled action ID if a scheduled action was found, or null if no matching action found.
as_unschedule_all_actions(string $hook, array $args = array(), string $group = '') : mixed
Cancel all occurrences of a scheduled action.
| string | $hook | The hook that the job will trigger. |
| array | $args | Args that would have been passed to the job. |
| string | $group | The group the job is assigned to. |
um_after_insert_user(int|\WP_Error $user_id, array $args, null|array $form_data = null) : mixed
After insert a new user run at frontend and backend.
| int|\WP_Error | $user_id | |
| array | $args | |
| null|array | $form_data | It's null in case when posted from wp-admin > Add user |
um_comment_link_to_profile(string $return, string $author, string $comment_id) : string
Control comment author display.
| string | $return | The HTML-formatted comment author link. |
| string | $author | The comment author's username. |
| string | $comment_id | The comment ID as a numeric string. |
um_fetch_user( $user_id) : mixed
Sets a specific user and prepares profile data and user permissions and makes them accessible.
| $user_id | (required) A user ID is required. This is the user's ID that you wish to set/retrieve |
um_get_avatar(string $avatar = '', string $id_or_email = '', string $size = '96', string $avatar_class = '', string $default = '', string $alt = '') : string
Get user UM avatars.
| string | $avatar | |
| string | $id_or_email | |
| string | $size | |
| string | $avatar_class | |
| string | $default | |
| string | $alt |
returns avatar in image html elements
um_get_canonical_url(string $canonical_url, \WP_Post $post) : string|bool
Fix SEO canonical for the profile page
| string | $canonical_url | The canonical URL. |
| \WP_Post | $post | Optional. Post ID or object. Default is global |
The canonical URL, or false if current URL is canonical.
um_is_amp(bool $check_theme_support = true) : bool
Check whether the current page is in AMP mode or not.
We need to check for specific functions, as there is no special AMP header.
| bool | $check_theme_support | Whether theme support should be checked. Defaults to true. |
um_maybe_flush_users_session_update_user(bool $send, array $user, array $userdata) : bool
Maybe clear all sessions except current after changing email. Because email can be used for login.
Using a proper hook that triggers on email changed action in WordPress native handlers. It starts to work sitewide in UM Account and there wp_update_user with new user_email attribute is used.
| bool | $send | Whether to send the email. |
| array | $user | The original user array. |
| array | $userdata | The updated user array. |
um_safe_redirect(string $url) : mixed
UM safe redirect. By default, you can be redirected only to WordPress installation Home URL. Fallback URL is wp-admin URL.
But it can be changed through filters and extended by UM Setting "Allowed hosts for safe redirect (one host per line)" and filter um_wp_safe_redirect_fallback.
| string | $url | redirect URL. |
um_submit_form_data_role_fields(array $post_form, string $mode, array $all_cf_metakeys) : array
Add `role_select` and `role_radio` to the $post_form It is necessary for that if on these fields the conditional logic.
| array | $post_form | |
| string | $mode | |
| array | $all_cf_metakeys |
wc_get_scheduled_actions(array $args = array(), string $return_format = OBJECT) : array
Find scheduled actions
| array | $args | Possible arguments, with their default values: 'hook' => '' - the name of the action that will be triggered 'args' => NULL - the args array that will be passed with the action 'date' => NULL - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. 'date_compare' => '<=' - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '=' 'modified' => NULL - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. 'modified_compare' => '<=' - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '=' 'group' => '' - the group the action belongs to 'status' => '' - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING 'claimed' => NULL - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID 'per_page' => 5 - Number of results to return 'offset' => 0 'orderby' => 'date' - accepted values are 'hook', 'group', 'modified', or 'date' 'order' => 'ASC'. |
| string | $return_format | OBJECT, ARRAY_A, or ids. |
wc_next_scheduled_action(string $hook, array $args = null, string $group = '') : int|bool
Get next scheduled action.
| string | $hook | Action's hook. |
| array | $args | Action's args. |
| string | $group | Action's group. |
The timestamp for the next occurrence, or false if nothing was found
wc_schedule_cron_action(int $timestamp, string $schedule, string $hook, array $args = array(), string $group = '') : string
Schedule an action that recurs on a cron-like schedule.
| int | $timestamp | The schedule will start on or after this time. |
| string | $schedule | A cron-link schedule string. |
| string | $hook | The hook to trigger. |
| array | $args | Arguments to pass when the hook triggers. |
| string | $group | The group to assign this job to. |
The job ID
wc_schedule_recurring_action(int $timestamp, int $interval_in_seconds, string $hook, array $args = array(), string $group = '') : string
Schedule a recurring action.
| int | $timestamp | When the first instance of the job will run. |
| int | $interval_in_seconds | How long to wait between runs. |
| string | $hook | The hook to trigger. |
| array | $args | Arguments to pass when the hook triggers. |
| string | $group | The group to assign this job to. |
The job ID
wc_schedule_single_action(int $timestamp, string $hook, array $args = array(), string $group = '') : string
Schedule an action to run one time.
| int | $timestamp | When the job will run. |
| string | $hook | The hook to trigger. |
| array | $args | Arguments to pass when the hook triggers. |
| string | $group | The group to assign this job to. |
The job ID
wc_unschedule_action(string $hook, array $args = array(), string $group = '') : mixed
Cancel the next occurrence of a job.
| string | $hook | The hook that the job will trigger. |
| array | $args | Args that would have been passed to the job. |
| string | $group | Action's group. |