عرض مصدر PHP/highlight string

<noinclude>{{DISPLAYTITLE:الدالة <code>highlight_string()</code>‎ في PHP}}</noinclude>
(PHP 4, PHP 5, PHP 7)

تلوّن الدالةُ highlight_string()‎ شيفرات PHP في سلسلة نصية.

== الوصف ==
<syntaxhighlight lang="php">
mixed highlight_string ( string $str [, bool $return = FALSE ] )
</syntaxhighlight>تطبع أو تعيد الدالةُ highlight_string()‎ ترميزَ html لإصدارٍ ملونٍ من شيفرات PHP المعطاة باستخدام الألوان المُعرَّفة في ملوِّن الشيفرات المدمج في PHP.

== المعاملات ==

=== str ===
شيفرة PHP المراد تلوينها. يجب أن تتضمن هذه الشيفرة وسمَ الفتح.

=== return ===
ضبط المعامل return إلى القيمة TRUE سيؤدي إلى إعادة الدالة highlight_string()‎ للشيفرة الملوّنة بدل طباعتها مباشرةً.

== القيم المعادة ==
إذا ضُبِطَ المعامل return إلى القيمة TRUE، فستُعاد الشيفرة الملونة كسلسلة نصية بدلًا من طباعتها. وإلا، فستُعاد القيمة TRUE عند النجاح، والقيمة FALSE عند الفشل.

== أمثلة ==
المثال 1: مثال على الدالة highlight_string()‎<syntaxhighlight lang="php">
<?php

highlight_string('<?php phpinfo(); ?>');

?>
</syntaxhighlight>ناتج المثال السابق:<syntaxhighlight lang="php">
<code><span style="color: #000000">

<span style="color: #0000BB">&lt;?php&nbsp;phpinfo</span><span style="color: #007700">();&nbsp;</span><span style="color: #0000BB">?&gt;</span>

</span>

</code>
</syntaxhighlight>

== ملاحظات ==
ملحوظة: عند استخدام المعامل return، تَستخدِمُ الدالةُ highlight_string()‎ التخزينَ المؤقت للإخراج الداخلي بحيث لا يمكن استخدامها داخل دالة رد النداء ob_start()‎.

ترميز HTML المُنْشَأُ عُرضةٌ للتغيير.

== انظر أيضًا ==
* الدالة highlight_file()‎: تلوين شيفرات PHP في مَلفّ.

== مصادر ==
* [http://php.net/manual/en/function.highlight-string.php صفحة الدالة highlight_string في توثيق PHP الرسمي.]
[[تصنيف:PHP]]
[[تصنيف:PHP Function]]
[[تصنيف:PHP Miscellaneous]]