wp_user_request_action_description() WordPress Function
The wp_user_request_action_description function is used to output a user-requested action description. This function is used when a user requests an action from another user. The function outputs a description of the action that the user is requesting.
wp_user_request_action_description( string $action_name ) #
Gets action description from the name and return a string.
Parameters
- $action_name
(string)(Required)Action name of the request.
Return
(string) Human readable action name.
Source
File: wp-includes/user.php
function wp_user_request_action_description( $action_name ) {
switch ( $action_name ) {
case 'export_personal_data':
$description = __( 'Export Personal Data' );
break;
case 'remove_personal_data':
$description = __( 'Erase Personal Data' );
break;
default:
/* translators: %s: Action name. */
$description = sprintf( __( 'Confirm the "%s" action' ), $action_name );
break;
}
/**
* Filters the user action description.
*
* @since 4.9.6
*
* @param string $description The default description.
* @param string $action_name The name of the request.
*/
return apply_filters( 'user_request_action_description', $description, $action_name );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.9.6 | Introduced. |