php8.5
Home/ Manual/ intl / locale/ Locale::isRightToLeft

Locale::isRightToLeft

PHP function Edit on GitHub ✎

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

Description

Oop

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

Procedural

locale_is_right_to_left(string $locale = ""): bool

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

VersionDescription
8.5.0Added Locale::isRightToLeft.

Examples

Checking text direction for a locale

php
<?php

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

The above example will output:

output
bool(false)
bool(true)

Source: reference/intl/locale/isrighttoleft.xml · from the official PHP manual (php/doc-en)