Locale::isRightToLeft

locale_is_right_to_left

Check whether a locale uses a right-to-left writing system

Description

Object-oriented style

public static bool Locale::isRightToLeft( string $locale = "" )

Procedural style

bool locale_is_right_to_left(string $locale = "")

Determines whether a locale uses a right-to-left writing system.

This method relies on the ICU library and evaluates the dominant script associated with the locale.

Parameters

locale
The locale identifier. If empty, the default locale is used.

Return Values

Returns true if the locale uses a right-to-left writing system, or false otherwise.

Changelog

Version Description
8.5.0 Added Locale::isRightToLeft.

Examples

Example #1 Checking text direction for a locale

<?php

var_dump(Locale::isRightToLeft('en-US'));
var_dump(Locale::isRightToLeft('ar'));

The above example will output:

bool(false)
bool(true)