A WordPress-centric search engine for devs and theme authors



wp_user_request_action_description ›

Since4.9.6
Deprecatedn/a
wp_user_request_action_description ( $action_name )
Parameters:
  • (string) $action_name Action name of the request.
    Required: Yes
Returns:
  • (string) Human readable action name.
Defined at:
Codex:

Get action description from the name and return a string.



Source

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 );
}