PHP/wordwrap

(PHP 4, PHP 5, PHP 7)

تُجري الدالة wordwrap()‎ التفافًا (wrap) للسلسلة النصيَّة الممرَّرة إليها عند عدد محدَّد من المحارف.

الوصف

string wordwrap ( string $str [, int $width = 75 [, string $break = "\n" [, bool $cut = FALSE ]]] )

تؤمِّن هذه الدالة التفاف السلسلة النصيَّة str عند عدد محدَّد من المحارف وباستعمال محرف مخصَّص لفصل تلك السلسلة.

المعاملات

str

السلسلة النصيَّة المراد إجراء التفاف لها.

width

عدد المحارف التي ستَلتفُّ عندها السلسلة النصيَّة str.

break

معامل اختياري وهو المحرف الذي سيُستعمل فاصلًا للأسطر عند عمليَّة الالتفاف.

cut

إن كانت قيمة المعامل TRUE، فستُجرَى عملية الإلتفاف عند قيمة المعامل width بالضبط أو قبل تلك القيمة؛ وبذلك نجد أنَّه إن صدف وجود كلمة أطول من القيمة المعطاة في المعامل width، فستُقطع هذه الكلمة إلى قسمين بما يتناسب مع قيمة ذلك المعامل. راجع المثال 2 للمزيد من الوضوح.

إن كانت قيمة المعامل FALSE، فلن تُقطع الكلمة إلى قسمين حتى لو كان طولها أكبر من قيمة المعامل width. راجع المثال 3 للمزيد من الوضوح.

القيم المعادة

تُعاد السلسلة النصيَّة str بعد إجراء التفافٍ لها عند طول محدَّد من المحارف.

أمثلة

المثال 1: استعمال الدالة wordwrap()‎

<?php
$text = "The quick brown fox jumped over the lazy dog.";
$newtext = wordwrap($text, 20, "<br />\n");

echo $newtext;
?>

سيُظهر المثال السابق النتيجة التالية:

The quick brown fox<br />
jumped over the lazy<br />
dog.

المثال 2: استعمال القيمة TRUE مع المعامل cut

<?php
$text = "A very long woooooooooooord.";
$newtext = wordwrap($text, 8, "\n", true);

echo "$newtext\n";
?>

سيُظهر المثال السابق النتيجة التالية:

A very
long
wooooooo
ooooord.

المثال 3: استعمال القيمة FALSE مع المعامل cut

<?php
$text = "A very long woooooooooooooooooord. and something";
$newtext = wordwrap($text, 8, "\n", false);

echo "$newtext\n";
?>

سيُظهر المثال السابق النتيجة التالية:

A very
long
woooooooooooooooooord.
and
something

انظر أيضًا

• الدالة nl2br()‎: إضافة العنصر <br> في HTML قبل جميع محارف الأسطر الجديدة في السلسلة النصيَّة.
• الدالة chunk_split()‎: تقطيع السلسلة النصيَّة إلى -أجزاء أصغر.

مصادر

• صفحة الدالة wordwrap في توثيق PHP الرسمي.