wp_user_request_action_description( string $action_name )

Get action description from the name and return a string.


Parameters Parameters

$action_name

(string) (Required) Action name of the request.


Top ↑

Return Return

(string) Human readable action name.


Top ↑

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


Top ↑

Changelog Changelog

Changelog
Version Description
4.9.6 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.