PHPackages                             ysp/pinyin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. ysp/pinyin

Active1[Utility & Helpers](/categories/utility)

ysp/pinyin
==========

Chinese Pinyin package for >=php7.1

v1.0.2(2y ago)020MITPHPPHP >=7.1

Since Mar 21Pushed 2y ago1 watchersCompare

[ Source](https://github.com/askme-gpt/pinyin)[ Packagist](https://packagist.org/packages/ysp/pinyin)[ RSS](/packages/ysp-pinyin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

来源
==

[](#来源)

这个包来源于： ，为啥要做同个功能的轮子呢？因为最新的源包（^5.0版本）不支持php8以前的版本，我有些老项目，升级比较麻烦，因此把代码稍微改了一下，以便php7.1以后的版本都能用。 如果你的php版本在php8以上，请使用  ，以便获取最新的更新，虽然我的这个包也能在php8的环境下跑，但是性能肯定没有官方的那么好，因为jit原因。

如果遇到不兼容的问题，直接提issue，我会尽量在24小时之内处理完毕。

主要改动
====

[](#主要改动)

\-- str\_contains ：在 PHP 7.1 中，str\_contains 函数是不可用的，因为它是在 PHP 8.0 中引入的。 -- fn ($pinyin) ：fn 关键字，因为匿名函数（Arrow Function）是在 PHP 7.4 中引入的。

Pinyin
======

[](#pinyin)

[![Test](https://github.com/askme-gpt/pinyin/actions/workflows/test.yml/badge.svg)](https://github.com/askme-gpt/pinyin/actions/workflows/test.yml)[![Latest Stable Version](https://camo.githubusercontent.com/10cbf8c470851ad0bebd058635ad6a781608dfc585994e7837e6578735bf8bb0/68747470733a2f2f706f7365722e707567782e6f72672f6f766572747275652f70696e79696e2f762f737461626c652e737667)](https://packagist.org/packages/overtrue/pinyin) [![Total Downloads](https://camo.githubusercontent.com/7a1ba91c5227ad10249bc6b1c7ca4d01a91e4151b8c6148e02594049132fe200/68747470733a2f2f706f7365722e707567782e6f72672f6f766572747275652f70696e79696e2f646f776e6c6f6164732e737667)](https://packagist.org/packages/overtrue/pinyin) [![Latest Unstable Version](https://camo.githubusercontent.com/33da35dba8b7f80211bb8dec99ae1d4feec1dc089a0c2f653dcad00c58f49c1a/68747470733a2f2f706f7365722e707567782e6f72672f6f766572747275652f70696e79696e2f762f756e737461626c652e737667)](https://packagist.org/packages/overtrue/pinyin) [![License](https://camo.githubusercontent.com/b66704519178e7ac6e1749812b75fcb59d56d65e2510f866b968d8a27ce23846/68747470733a2f2f706f7365722e707567782e6f72672f6f766572747275652f70696e79696e2f6c6963656e73652e737667)](https://packagist.org/packages/overtrue/pinyin)

🇨🇳 基于 [mozillazg/pinyin-data](https://github.com/mozillazg/pinyin-data) 词典的中文转拼音工具，更准确的支持多音字的汉字转拼音解决方案。

安装
--

[](#安装)

使用 Composer 安装:

```
composer require ysp/pinyin:^1.0
```

使用
--

[](#使用)

### 拼音风格

[](#拼音风格)

除了获取首字母的方法外，所有方法都支持第二个参数，用于指定拼音的格式，可选值为：

- `symbol` （默认）声调符号，例如 `pīn yīn`
- `none` 不输出拼音，例如 `pin yin`
- `number` 末尾数字模式的拼音，例如 `pin1 yin1`

### 返回值

[](#返回值)

除了 `permalink` 返回字符串外，其它方法都返回集合类型 [`Ysp\Pinyin\Collection`](https://github.com/askme-gpt/pinyin/blob/master/src/Collection.php)：

```
use Ysp\Pinyin\Pinyin;

$pinyin = Pinyin::sentence('你好，世界');
```

你可以通过以下方式访问集合内容:

```
echo $pinyin; // nǐ hǎo shì jiè

// 直接将对象转成字符串
$string = (string) $pinyin; // nǐ hǎo shì jiè

$pinyin->toArray(); // ['nǐ', 'hǎo', 'shì', 'jiè']

// 直接使用索引访问
$pinyin[0]; // 'nǐ'

// 使用函数遍历
$pinyin->map('ucfirst'); // ['Nǐ', 'Hǎo', 'Shì', 'Jiè']

// 拼接为字符串
$pinyin->join(' '); // 'nǐ hǎo shì jiè'
$pinyin->join('-'); // 'nǐ-hǎo-shì-jiè'

// 转成 json
$pinyin->toJson(); // '["nǐ","hǎo","shì","jiè"]'
json_encode($pinyin); // '["nǐ","hǎo","shì","jiè"]'
```

### 文字段落转拼音

[](#文字段落转拼音)

```
use Ysp\Pinyin\Pinyin;

echo Pinyin::sentence('带着希望去旅行，比到达终点更美好');
// dài zhe xī wàng qù lǚ xíng ， bǐ dào dá zhōng diǎn gèng měi hǎo

// 去除声调
echo Pinyin::sentence('带着希望去旅行，比到达终点更美好', 'none');
// dai zhe xi wang qu lv xing ， bi dao da zhong dian geng mei hao

// 保留所有非汉字字符
echo Pinyin::fullSentence('ル是片假名，π是希腊字母', 'none');
// ル shi pian jia ming ，π shi xi la zi mu
```

### 生成用于链接的拼音字符串

[](#生成用于链接的拼音字符串)

通常用于文章链接等，可以使用 `permalink` 方法获取拼音字符串：

```
echo Pinyin::permalink('带着希望去旅行'); // dai-zhe-xi-wang-qu-lyu-xing
echo Pinyin::permalink('带着希望去旅行', '.'); // dai.zhe.xi.wang.qu.lyu.xing
```

### 获取首字符字符串

[](#获取首字符字符串)

通常用于创建搜索用的索引，可以使用 `abbr` 方法转换：

```
Pinyin::abbr('带着希望去旅行'); // ['d', 'z', 'x', 'w', 'q', 'l', 'x']
echo Pinyin::abbr('带着希望去旅行')->join('-'); // d-z-x-w-q-l-x
echo Pinyin::abbr('你好2018！')->join(''); // nh2018
echo Pinyin::abbr('Happy New Year! 2018！')->join(''); // HNY2018
```

**姓名首字母**

将首字作为姓氏转换，其余作为普通词语转换：

```
Pinyin::nameAbbr('欧阳'); // ['o', 'y']
echo Pinyin::nameAbbr('单单单')->join('-'); // s-d-d
```

### 姓名转换

[](#姓名转换)

姓名的姓的读音有些与普通字不一样，比如 ‘单’ 常见的音为 `dan`，而作为姓的时候读 `shan`。

```
Pinyin::name('单某某'); // ['shàn', 'mǒu', 'mǒu']
Pinyin::name('单某某', 'none'); // ['shan', 'mou', 'mou']
Pinyin::name('单某某', 'none')->join('-'); // shan-mou-mou
```

### 护照姓名转换

[](#护照姓名转换)

根据国家规定 [关于中国护照旅行证上姓名拼音 ü（吕、律、闾、绿、女等）统一拼写为 YU 的提醒](http://sg.china-embassy.gov.cn/lsfw/zghz1/hzzxdt/201501/t20150122_2022198.htm) 的规则，将 `ü` 转换为 `yu`：

```
Pinyin::passportName('吕小布'); // ['lyu', 'xiao', 'bu']
Pinyin::passportName('女小花'); // ['nyu', 'xiao', 'hua']
Pinyin::passportName('律师'); // ['lyu', 'shi']
```

### 多音字

[](#多音字)

多音字的返回值为关联数组的集合，默认返回去重后的所有读音：

```
$pinyin = Pinyin::polyphones('重庆');

$pinyin['重']; // ["zhòng", "chóng", "tóng"]
$pinyin['庆']; // ["qìng"]

$pinyin->toArray();
// [
//     "重": ["zhòng", "chóng", "tóng"],
//     "庆": ["qìng"]
// ]
```

如果不想要去重，可以数组形式返回：

```
$pinyin = Pinyin::polyphones('重庆重庆', Converter::TONE_STYLE_SYMBOL, true);

// or
$pinyin = Pinyin::polyphonesAsArray('重庆重庆', Converter::TONE_STYLE_SYMBOL);

$pinyin->toArray();
// [
//     ["重" => ["zhòng", "chóng", "tóng"]],
//     ["庆" => ["qìng"]],
//     ["重" => ["zhòng", "chóng", "tóng"]],
//     ["庆" => ["qìng"]]
// ]
```

### 单字转拼音

[](#单字转拼音)

和多音字类似，单字的返回值为字符串，多音字将根据该字字频调整得到常用音：

```
$pinyin = Pinyin::chars('重庆');

echo $pinyin['重']; // "zhòng"
echo $pinyin['庆']; // "qìng"

$pinyin->toArray();
// [
//     "重": "zhòng",
//     "庆": "qìng"
// ]
```

> **Warning**
>
> 当单字处理时由于多音字来自词频表中取得常用音，所以在词语环境下可能出现不正确的情况，建议使用多音字处理。

更多使用请参考 [测试用例](https://github.com/askme-gpt/pinyin/blob/master/tests/PinyinTest.php)。

v/yu/ü 的问题
----------

[](#vyuü-的问题)

根据国家语言文字工作委员会的规定，`lv`、`lyu`、`lǚ` 都是正确的，但是 `lv` 是最常用的，所以默认使用 `lv`，如果你需要使用其他的，可以在初始化时传入：

```
echo Pinyin::sentence('旅行');
// lǚ xíng

echo Pinyin::sentence('旅行', 'none');
// lv xing

echo Pinyin::yuToYu()->sentence('旅行', 'none');
// lyu xing

echo Pinyin::yuToU()->sentence('旅行', 'none');
// lu xing

echo Pinyin::yuToV()->sentence('旅行', 'none');
// lv xing
```

> **Warning**
>
> 仅在拼音风格为非 `none` 模式下有效。

命令行工具
-----

[](#命令行工具)

你可以使用命令行来实现拼音的转换：

```
php ./bin/pinyin 带着希望去旅行 --method=sentence --tone-style=symbol
# dài zhe xī wàng qù lǚ xíng
```

更多使用方法，可以查看帮助文档：

```
php ./bin/pinyin --help

# Usage:
#     ./pinyin [chinese] [method] [options]
# Options:
#     -j, --json               输出 JSON 格式.
#     -c, --compact            不格式化输出 JSON.
#     -m, --method=[method]    转换方式，可选：sentence/sentenceFull/permalink/abbr/nameAbbr/name/passportName/phrase/polyphones/chars.
#     --no-tone                不使用音调.
#     --tone-style=[style]     音调风格，可选值：symbol/none/number, default: none.
#     -h, --help               显示帮助.
```

中文简繁转换
------

[](#中文简繁转换)

如何你有这个需求，也可以了解我的另一个包：[overtrue/php-opencc](https://github.com/askme-gpt/php-opencc)

Contribution
------------

[](#contribution)

欢迎提意见及完善补充词库：

- 单字拼音错误请添加到：[data/pathes/chars.txt](https://github.com/askme-gpt/pinyin/blob/master/data/pathes/chars.txt)；
- 词语错误或补齐，请添加到：[data/pathes/words.txt](https://github.com/askme-gpt/pinyin/blob/master/data/pathes/words.txt)；

参考
--

[](#参考)

- [mozillazg/pinyin-data](https://github.com/mozillazg/pinyin-data)
- [详细参考资料](https://github.com/askme-gpt/pinyin-resources)

License
=======

[](#license)

MIT

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

789d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9b35a2dc6ed6d92d594dc02835a590ff053a1c39448f33c53c9c37a8fe08dc11?d=identicon)[ShuiPingYang](/maintainers/ShuiPingYang)

---

Top Contributors

[![dbx192](https://avatars.githubusercontent.com/u/131589877?v=4)](https://github.com/dbx192 "dbx192 (3 commits)")

---

Tags

PinyinChinesecn2pinyin

### Embed Badge

![Health badge](/badges/ysp-pinyin/health.svg)

```
[![Health](https://phpackages.com/badges/ysp-pinyin/health.svg)](https://phpackages.com/packages/ysp-pinyin)
```

###  Alternatives

[overtrue/pinyin

Chinese to pinyin translator.

4.5k6.5M72](/packages/overtrue-pinyin)[zhuzhichao/ip-location-zh

get the ip's location info with Chinese

617212.5k11](/packages/zhuzhichao-ip-location-zh)[overtrue/chinese-calendar

中国农历转换与查询工具

557103.7k4](/packages/overtrue-chinese-calendar)[zhuzhichao/bank-card-info

Get the bank card info

45464.8k](/packages/zhuzhichao-bank-card-info)[douyasi/identity-card

Chinese Identity Card package

17851.4k3](/packages/douyasi-identity-card)[thl/pinyin

Romanization tool for Traditional Chinese

2519.1k](/packages/thl-pinyin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)