فهم أهمية معايير الترميز

معايير البرمجة مثل القواعد النحوية للبرمجة. فكما أن القواعد النحوية السليمة تجعل اللغة المكتوبة واضحة ومفهومة، فإن معايير البرمجة تجعل شفرتك البرمجية متسقة ومقروءة.

• من أجلك: You’ll find it easier to read and update your code in the future.
• للآخرين: إذا كنت تشارك التعليمات البرمجية الخاصة بك أو تعمل في فريق، فسيقدر الآخرون الوضوح.
• للوردبريس: Since it’s open-source, many people contribute. Standards keep everything unified.

التطبيق الواقعي لمعايير البرمجة في العالم الحقيقي في العمل الجماعي

Imagine you’re working on a WordPress project as part of a large team. Everyone contributes different parts of the code—some focus on the backend, others on styling, and others on accessibility. Without consistent standards, the project can become chaotic quickly. Coding standards ensure that:

• التعاون السلس: When everyone follows the same rules, it’s easier for developers to read and understand each other’s work.
• تعارضات دمج أقل: غالبًا ما يؤدي التنسيق غير المتسق إلى تعارضات في التعليمات البرمجية عند دمج التغييرات. تقلل المعايير من هذه التعارضات، مما يسمح للفريق بالعمل بكفاءة أكبر.
• تأهيل أفضل على متن الطائرة: يمكن للمطوّرين الجدد الذين ينضمون إلى المشروع أن يتعلموا بسرعة من خلال اتباع أسلوب ترميز موحد، مما يقلل من الوقت المستغرق في فهم الكود الحالي.

ضع في اعتبارك سيناريو يغادر فيه أحد المطورين المشروع، ويحتاج عضو جديد في الفريق إلى تولي دوره. إذا اتبع المطور السابق معايير الترميز السليمة، يمكن للعضو الجديد أن يقفز بسرعة ويحافظ على الكود البرمجي ويجري تحسينات دون الحاجة إلى الكثير من الوقت لفهمه.

معايير ترميز ووردبريس PHP

PHP is WordPress’s core language. Following the PHP coding standards ensures that your code integrates smoothly with WordPress and is easy for others to understand.

1- علامات PHP: استخدم دائمًا علامات PHP كاملة <?php ?>. تجنب العلامات القصيرة مثل <? ?> لأنها قد لا تعمل على جميع الخوادم.

<?php
// Your PHP code here
?>

2- ترميز الملفات: احفظ ملفات PHP الخاصة بك في UTF-8 بدون علامة ترتيب البايت (BOM).

3- نهايات الأسطر: استخدم نهايات الأسطر بنمط يونيكس (\n).

4- المسافة البادئة: استخدم علامات التبويب للمسافة البادئة (وليس المسافات). هذا يحافظ على اتساق الشيفرة عبر المحررين المختلفين.

اصطلاحات التسمية

1- الوظائف والطرق: استخدم الحروف الصغيرة والشروط السفلية.

دالة get_user_data( $user_id ) {
    // رمز الدالة
}

2- المتغيرات: مثل الدوال - الأحرف الصغيرة والشروط السفلية.

$user_اسم المستخدم = "مجهول الهوية";

3-الفصول الدراسية: استخدام الكلمات المكتوبة بأحرف كبيرة (StudlyCaps).

فئة ملف تعريف المستخدم {
// رمز الفئة
}

4- الثوابت: جميع الأحرف الكبيرة مع شرطة سفلية.

تعريف ( 'MAX_UPLOAD_SIZE, 1048576 );

المسافة البيضاء والمسافة البادئة

1- المسافات بعد الفواصل: عند سرد المعلمات أو عناصر المصفوفة، قم بتضمين مسافة بعد كل فاصلة.

$colors = مصفوفة ("أحمر"، "أخضر"، "أزرق" );

2- هياكل التحكم: ضع مسافة بين كلمات التحكم الرئيسية والقوس الافتتاحي.

إذا ($condition) {
    // الرمز
}

3-المشغلات: قم بتضمين مسافات حول عوامل التخصيص والمقارنة والعوامل المنطقية.

$total = $price + $ax;
إذا ( $OTAL > 100 ) {
    // الرمز
}

هياكل التحكم

1- وضع الأقواس: استخدم أسلوب ألمان، حيث تكون الدعامة الافتتاحية على خط جديد.

إذا ( $condition )
{
    // الرمز
}
في حالة أخرى
{
    // كود
}

2.غير ذلك إذا** كلمة رئيسية**: الاستخدام غير ذلك إذا بدلاً من وإلا إذا.

إذا ( $condition )
{
    // الرمز
}
في حالة أخرى إذا ( $P4Tother_condition )
{
    // كود
}

3- شروط يودا: ضع الثابت أو الحرفي على الجانب الأيسر من المقارنات.

إذا ( true === $is_active)
{
    // الرمز
}

يساعد هذا في منع التعيين العرضي (= بدلاً من ==).

أفضل الممارسات

1- تجنب علامات PHP المختزلة: استخدم دائمًا العلامات الكاملة لتوافق أفضل.

2- وسيطات الدالة: استخدم أسماء متغيرات واضحة ووصفية.

الدالة calculate_total( $subtotal, $ax_ rate ) {
    // الرمز
}

3- تعقيم المدخلات: قم دائمًا بتعقيم مدخلات المستخدم والتحقق من صحة المدخلات.

$user_id = intval( $_GET['user_id'] );

4- الهروب من المخرجات: قبل إخراج البيانات، قم بالهروب منها لمنع حدوث مشكلات أمنية.

صدى esc_html( $user_name );

5- التعليقات: استخدم التعليقات لشرح المنطق المعقد أو الملاحظات المهمة.

// احسب السعر الإجمالي مع الضريبة

معايير التوثيق المضمنة

التوثيق السليم يجعل من السهل فهم شفرتك البرمجية وصيانتها.

1- تعليقات الدالة: قبل كل دالة، قم بتضمين كتلة تعليق قبل كل دالة.

/**
 * يحسب السعر الإجمالي شاملاً الضريبة.
 *
 *param float $subtotal المبلغ الإجمالي الفرعي.
 * @param float $ax_rate معدل الضريبة كعدد عشري.
 *العائد عائم السعر الإجمالي.
 */
الدالة calculate_total( $subtotal, $ax_ rate) {
    // رمز الدالة
}

2- أنواع المعلمات والإرجاع: حدد نوع كل معلمة وقيمة الإرجاع.

3- التعليقات المضمنة: استخدمها باعتدال لشرح الأجزاء المعقدة من شفرتك البرمجية.

$discount = 0.0؛ // تهيئة متغير الخصم

معايير ترميز HTML في ووردبريس

HTML هو العمود الفقري لمحتوى الويب. إن كتابة HTML نظيف ودلالي أمر بالغ الأهمية لإمكانية الوصول وتحسين محركات البحث.

إرشادات عامة

1-النوع: ابدأ دومًا بنوع HTML5.

<!DOCTYPE html>

2- سمة اللغة: حدد اللغة في <html> الوسم.

<html lang="en">

3- ترميز الأحرف: استخدم ترميز UTF-8.

<meta charset="UTF-8">

هيكلة HTML الخاص بك

1- العناصر الدلالية: استخدم عناصر HTML5 الدلالية مثل <header>,

معايير ترميز CSS في ووردبريس

تتحكم CSS في العرض التقديمي لموقعك الإلكتروني. إن كتابة CSS نظيفة وفعالة تجعل موقعك يبدو جيدًا ويتم تحميله بشكل أسرع.

إرشادات عامة

1- بناء الجملة: اتبع بناء جملة CSS القياسي-محدد CSS، والأقواس، وأزواج الخصائص-القيم.

محدد الفئة-محدد الفئة {
    الخاصية: القيمة;
}

2- المسافة البادئة: استخدم مسافتين (أو علامتي تبويب) للمسافة البادئة داخل القواعد.

3- التعليقات: استخدم التعليقات لفصل الأقسام وشرح القواعد المعقدة.

/* أنماط الرؤوس *//
رأس {
    /* الخصائص *//
}

كتابة CSS نظيفة

1- أسماء المحددات: استخدم الأحرف الصغيرة والواصلات.

.التنقل الرئيسي {
    /* الأنماط *//
}

2- تجنب المعرفات للتصميم: استخدم الفئات بدلاً من المعرفات للحفاظ على الخصوصية.

/* صحيح*//
.زر {
    /* الأنماط *//
}

/* تجنب *//
زر #submit-button {
    /* الأنماط *//
}

3- الخصائص المختصرة: استخدم الخصائص المختصرة حيثما أمكن.

/* صحيح */
الهامش: 10 بكسل 5 بكسل 15 بكسل 0;

/* موسع *//
الهامش الأعلى: 10 بكسل;
الهامش لليمين: 5 بكسل;
الهامش السفلي: 15 بكسل;
الهامش الأيسر: 0;

4- القيم الصفرية: حذف وحدات القيم الصفرية.

الحشو: 0;

أفضل الممارسات

1- تنظيم الأنماط: تجميع الأنماط ذات الصلة معًا، مثل التخطيط والطباعة والألوان.

2- تعليقات الأقسام: استخدم التعليقات لتقسيم ورقة الأنماط الخاصة بك إلى أقسام.

/* الطباعة / / الألوان / / تخطيط */-

3- تجنب !مهم: استخدم الخصوصية بدلاً من !مهم لتجاوز الأنماط.

4- استعلامات الوسائط: ضع استعلامات الوسائط بالقرب من الأنماط ذات الصلة أو في قسم منفصل.

@media (الحد الأقصى للعرض: 768 بكسل) {
    .التنقل الرئيسي {
        العرض: لا شيء;
    }
}

الأدوات والمكونات الإضافية الموصى بها

للمساعدة في ضمان اتباعك لمعايير ترميز ووردبريس، فكِّر في استخدام الأدوات التالية:

1. برنامج PHP CodeSniffer: يمكن أن تساعد هذه الأداة في الكشف عن انتهاكات معايير ترميز ووردبريس PHP. يمكنك استخدامها مع مجموعة قواعد معايير ترميز ووردبريس للتحقق تلقائيًا من شفرتك البرمجية.
2. تكوين المحرر: تدعم العديد من المحررين IDEs ومحرري الأكواد ملفات .editorconfig، والتي تساعد في الحفاظ على أنماط ترميز متسقة بين المحررين والمطورين المختلفين.
3. ESLint و Stylelint: استخدم هذه الأدوات لنسالة JavaScript و CSS لاكتشاف الأخطاء الشائعة وفرض الاتساق.
4. أجمل: منسق كود يمكنه فرض نمط متناسق تلقائيًا لـ HTML و CSS و JavaScript، مما يسهل على الفرق الحفاظ على نمط كود موحد.
5. ملحقات رمز VSCode:
   • PHP Intelephense: يوفر الإكمال التلقائي الذكي وتلميحات الوظائف ويكتشف المشكلات المحتملة.
   • مقتطفات ووردبريس: مجموعة من دوال ومقتطفات ووردبريس شائعة الاستخدام لتسريع عملية التطوير.

الأخطاء الشائعة التي يجب تجنبها

1- التسمية غير متسقة: يمكن أن يؤدي الخلط بين camelCase و snake_case إلى حدوث ارتباك، لذا التزم باصطلاحات التسمية المحددة في مشروعك.

2.عدم الهروب من الإخراج: احرص دائمًا على الهروب من المحتوى الذي ينشئه المستخدم قبل إخراجه لمنع الثغرات الأمنية مثل XSS.

// صحيح
صدى esc_html( $user_input );

// غير صحيح
صدى $P4Tuser_input;

3- الاستخدام غير السليم للعوالم: تجنب استخدام المتغيرات العامة إلا عند الضرورة. بدلًا من ذلك، مرر المتغيرات بشكل صريح إلى الدوال للحفاظ على شفرتك معيارية وأكثر قابلية للاختبار.

4.استخدام الأنماط المضمنة: يجب تجنب الأنماط المضمنة لأنها تجعل من الصعب الحفاظ على CSS وتجاوزها. استخدم دائمًا أوراق الأنماط الخارجية.

تجميع كل شيء معًا

Let’s look at an example that combines PHP, HTML, and CSS following WordPress coding standards.

مثال: قالب PHP بسيط

ملف PHP (template-example.php):

<?php
/**
 * Template Name: Example Template
 *
 * A template to demonstrate coding standards.
 *
 * @package WordPress
 * @subpackage Your_Theme
 */

get_header(); ?>

<main id="main-content" class="site-main">
    <?php
    if ( have_posts() ) :
        while ( have_posts() ) :
            the_post(); ?>

            <article id="post-<?php the_ID(); ?>" no numeric noise key 1006>
                <header class="entry-header">
                    <?php the_title( '<h1>', '</h1>' ); ?>
                </header>

                <div class="entry-content">
                    <?php the_content(); ?>
                </div>
            </article>

        <?php endwhile;
    else : ?>

        <p><?php esc_html_e( 'Sorry, no posts matched your criteria.', 'your-text-domain' ); ?></p>

    <?php endif; ?>
</main>

<?php get_footer(); ?>

ملف CSS (style.css):

/* أنماط المحتوى الرئيسي *//
.الموقع الرئيسي {
    الهامش: 0 تلقائي;
    الحد الأقصى للعرض: 800 بكسل;
    الحشو: 20 بكسل;
}

.entry-header h1 {
    حجم الخط: 2 م;
    الهامش السفلي: 0.5 مليمتر;
}

.محتوى الإدخال {
    ارتفاع الخط: 1.6;
}

الموارد الإضافية

• دليل مطور ووردبريس للمطورين: developer.wordpress.org
• وثائق PHP: php.net
• شبكة مطوري Mozilla Developer Network (MDN) مستندات الويب:
  • HTML
  • CSS
  • جافا سكريبت
• خدمة التحقق من صحة العلامات W3C: المدقق. w3.org
• معايير الترميز في ووردبريس:
  • معايير PHP
  • معايير HTML
  • معايير CSS

الخاتمة

يضمن اتباع معايير ترميز ووردبريس أن تكون شفرتك نظيفة ومتسقة واحترافية. يساعدك هذا في الحفاظ على مشاريعك ويسهل على الآخرين في مجتمع ووردبريس التعاون معك.

تذكّر:

• الممارسة تصنع الكمال: كلما قمت بالبرمجة وفقًا لهذه المعايير، كلما أصبح الأمر طبيعيًا أكثر.
• ابق على اطلاع: معايير الترميز تتطور، لذا راقب وثائق ووردبريس الرسمية.
• اطلب المساعدة: إذا كنت بحاجة إلى توضيح، فإن مجتمع WordPress ودود ومستعد للمساعدة.

ترميز سعيد!