دليل معايير ترميز WordPress النهائي: ضروري للمطورين

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

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

لماذا تلتزم بمعايير ترميز WordPress؟

تهدف معايير ترميز WordPress إلى ضمان اتساق التعليمات البرمجية عبر المشاريع والمساهمين.  إنه يحسن قابلية القراءة وقابلية الصيانة للتطوير التعاوني ويسهل مراجعات التعليمات البرمجية والالتزام بأفضل الممارسات عبر نظام WordPress البيئي.

ما هي معايير ترميز ووردبريس؟

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

تعرف على المزيد: كيفية تقليل تأثير رمز الطرف الثالث؟

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

تساعد معايير الترميز على منع الأخطاء الشائعة وتحسين إمكانية قراءة التعليمات البرمجية وتبسيط التعديلات. من خلال الالتزام بها ، تظهر التعليمات البرمجية كما لو كانت مكتوبة من قبل شخص واحد ، مما يسهل على أي شخص فهمها وتعديلها.

المساهمة في ووردبريس الأساسية

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

مكونات معايير ترميز ووردبريس

تغطي المعايير الإرشادات الخاصة باللغة ل CSS و HTML و JavaScript و PHP ، بالإضافة إلى إرشادات إمكانية الوصول المتوافقة مع WCAG AA.

اقرأ أيضا: كيفية تحويل HTML إلى وورد موضوع؟

استثناء لمكتبات الطرف الثالث

ومع ذلك ، فإن مكتبات الجهات الخارجية المدمجة في WordPress معفاة من هذه المعايير.

أمثلة على معايير ترميز ووردبريس

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

PHP في وورد

يستخدم WordPress تحديثات PHP كلغة برمجة أساسية. يعد الالتزام بمعايير ترميز PHP أمرا بالغ الأهمية للحصول على كود قابل للصيانة ومتسق في WordPress. إليك سبب أهمية معايير ترميز PHP:

فواصل الأسطر

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

المسافه البادئه

لتسهيل قراءة التعليمات البرمجية الخاصة بك ، استخدم المسافة البادئة لإظهار بنيتها المنطقية. يجب استخدام علامات التبويب في بداية الأسطر ، بينما يتم استخدام المسافات للمسافة البادئة في منتصف السطر.

استخدام المساحة

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

نقلت

في WordPress ، القاعدة الرئيسية هي استخدام علامات اقتباس مفردة للسلاسل إلا إذا كنت تقوم بتقييم شيء ما بالداخل. إذا كنت بحاجة إلى علامات اقتباس داخل سلسلة ، فقم بالتبديل بين علامات الاقتباس الفردية والمزدوجة. يسمح بالهروب من عروض الأسعار ولكن نادرا ما يكون ضروريا.

الاقواس

أبسط طريقة هي استخدام الأقواس دائما. بينما تسمح المعايير بتخطي الأقواس لعبارات "if" أحادية السطر مع عدم وجود كتل متعددة الأسطر في نفس البنية ، فإن هذا غير مسموح به للحلقات أحادية السطر. أفضل دائما استخدام الأقواس من أجل الوضوح. بالإضافة إلى ذلك ، تحدد المعايير وضع دعامة الفتح على نفس السطر مثل البيان الأولي ، وليس أسفله كما هو الحال في وثائق PHP.

تنسيق استعلامات SQL

عند كتابة استعلامات SQL ، تذكر كتابة الكلمات الرئيسية بأحرف كبيرة. يجب تقسيم الاستعلامات المعقدة إلى أسطر متعددة. من المهم فهم طلبات البحث جيدا ، خاصة جوانبها الأمنية ، والتي سنناقشها لاحقا. تحدث هجمات حقن SQL بسبب أخطاء أمان WordPress ، مما يسمح للمتسللين بالوصول مباشرة إلى قاعدة البيانات ومعالجتها خلف موقع WordPress.

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

في كود WordPress ، تجنب CamelCase للأسماء. يجب أن تستخدم الدالات أحرف صغيرة، مع شرطات سفلية إذا لزم الأمر. يجب أن تكتب أسماء الفئات الحرف الأول من كل كلمة بأحرف كبيرة، مفصولة بشرطة سفلية.

يجب أن تكون أسماء الملفات كلها صغيرة ، مع واصلات بين الأجزاء. إذا كان الملف يحتوي على فئة واحدة ، فقم بتسميته بعد الفئة ، مسبوقا ب "class-".

استخدم قيم السلسلة لوسيطات الدالة بدلا من القيم المنطقية للوضوح. القاعدة الأكثر أهمية هي جعل الأسماء وصفية. في بيئة تعاونية ، اهدف إلى مساعدة الجميع على فهم التعليمات البرمجية الخاصة بك.

بيانات المقارنة

من الممارسات الجيدة ، ليس فقط ل WordPress ، وضع المتغير دائما على الجانب الأيمن من المقارنة. بهذه الطريقة ، إذا نسيت علامة المساواة ، فسيؤدي ذلك إلى حدوث خطأ بدلا من التقييم إلى صحيح. إذا كنت تحب استخدام عوامل التشغيل الثلاثية ، فهذا مسموح به ، لكن يوصى بالتحقق من الحقيقة لجعل الأمور أكثر وضوحا. الاستثناء هو عند التحقق من المتغيرات غير الفارغة باستخدام ! فارغة().

تنسيق HTML

وفقا ل WordPress Codex ، من المهم التحقق من صحة جميع تعليمات HTML البرمجية باستخدام W3C Validator. ومع ذلك ، لا يعني الرمز الصالح دائما أنه رمز جيد ، على الرغم من وجود اتصال واضح بين الاثنين.

نوع الوثيقة

يتبع WordPress مواصفات XHTML 1.0 الموصى بها من قبل W3C في عام 2000. على الرغم من ذلك ، فإن سمة Twenty Eleven ، وهي سمة افتراضية في WordPress ، تستخدم HTML5. لا يوجد تعارض حقيقي لأن HTML5 يتضمن تسلسل XML ، مما يسمح باستخدام "XHTML5".

استخدام علامات الاقتباس

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

إغلاق العلامات

تفرض مواصفات XHTML إغلاق جميع العلامات. يجب إغلاق العناصر الفارغة بشرطة مائلة للأمام قبل قوس الزاوية الأخير مباشرة. تأكد من وجود مسافة واحدة قبل الشرطة المائلة للأمام، كما هو محدد.

المسافه البادئه

ضع مسافة بادئة ل HTML باتباع نفس القواعد الخاصة ب PHP. استهدف بنية منطقية مع المسافة البادئة الخاصة بك. عند الجمع بين PHP و HTML ، ضع مسافة بادئة لكتل PHP بناء على التدفق المعتاد للمسافة البادئة.

تنسيق CSS 

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

اقرأ المزيد: كيفية إزالة CSS غير المستخدمة في وورد؟

المسافة البادئة والهيكل

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

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

استخدم الأحرف الصغيرة فقط. افصل بين الكلمات داخل محدد باستخدام واصلة. امنح محدداتك أسماء يمكن للبشر قراءتها.

الخصائص والقيم

هناك عدد غير قليل من القواعد لكتابة الخصائص والقيم. استخدم إصدارات مختصرة من الخصائص حيثما أمكن ذلك، إلا عند الكتابة فوق خاصية معرفة مسبقا. استخدم رمز HEX بأحرف صغيرة للألوان حيثما أمكن ذلك. إذا كان ذلك مناسبا ، استخدم الإصدار الأقصر. أدخل مسافة بعد النقطتين بعد خاصية. استخدم دائما الأحرف الصغيرة، إلا عندما يكون الحرف الكبير مطلوبا، مثل أسماء الخطوط والخصائص الخاصة بالمورد. قم بتنظيم خصائص CSS أبجديا ، باستثناء الخصائص الخاصة بالمورد ، والتي يجب أن تسبق دائما نظيرتها العامة ، وخصائص الأبعاد ، والتي يجب تجميعها معا. إذا تم تحديد العرض والارتفاع ، فاكتب العرض أولا.

التعليق

يدعم CSS نوعا واحدا فقط من التعليق - نمط الكتلة. لا يحتوي على تدوين منفصل للتعليقات المضمنة. اكتب تعليقات قصيرة على سطر واحد ، بدون فاصل أسطر أدناه. بالنسبة للتعليقات التي تمتد عبر أسطر متعددة، أدرج فاصل أسطر بعد بناء جملة الفتح مباشرة وفاصل أسطر قبل بناء جملة الإغلاق مباشرة. إذا كنت تستخدم التعليقات لتحديد أقسام التعليمات البرمجية ، فاستخدم الترميز التالي:

استخدام معالجات CSS الأولية

إن استخدام معالجات CSS المسبقة مثل SASS و Less يجعل حياتنا كمطورين أسهل كثيرا ، لكنها لا تخلو من العيوب. عادة ما يكون الرمز الذي تنتجه هذه الأدوات صالحا ولكن لا يمكن القول إنه نظيف جدا. ستكون ورقة الأنماط التي يتم إنتاجها يدويا (وبعناية) أكثر قابلية للقراءة من تلك التي يتم إنتاجها تلقائيا بواسطة Less. يعتمد ذلك على ما تفعله. إذا كان منتجك تجاريا ، فإن الهدف النهائي هو تجربة مستخدم جيدة ، مع رمز صالح ومحسن. في هذه الحالة ، استخدم إخراج المعالج المسبق باعتباره CSS الرئيسي ، ولكن قم بتضمين الملف الأصلي للمطورين. في حين أن CSS الخاص بك لن يتوافق مع معايير WordPress ، بما في ذلك الملف الأصلي يسد الفجوة إلى حد ما حتى يتخذ WordPress موقفا رسميا. التضحية بمعايير ترميز CSS من أجل تبسيط عملية التطوير (بهدف تجربة مستخدم أفضل) أمر جيد. التضحية بصحة الكود ليست كذلك.

كيف يمكنك المساهمة في معايير ترميز WordPress؟

البرمجة مثل الكتابة - لكل شخص أسلوبه الفريد. قد تبدو HTML الخاصة بك مختلفة عن بلدي ، جافا سكريبت الخاص بي يمكن أن تجعل عينيك تنزف ، ويمكن أن يكون CSS الخاص بك جميلا يغير الحياة. ولكن عندما يتعلق الأمر بالتعاون في مشروع مثل WordPress ، فإن وجود معايير ترميز متسقة أمر بالغ الأهمية.

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

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

الاستنتاجات

يعد الالتزام بمعايير ترميز WordPress أمرا ضروريا للحفاظ على قاعدة بيانات متماسكة وتعاونية. تعمل هذه الإرشادات ، التي طورها مجتمع WordPress ، كلغة مشتركة للمساهمين في جميع أنحاء العالم. باتباع معايير PHP و HTML و CSS و JavaScript وإمكانية الوصول ، يمكن للمطورين التأكد من أن التعليمات البرمجية الخاصة بهم متسقة وقابلة للقراءة وقابلة للصيانة.

مع استمرار تطور WordPress ، ستلعب معايير الترميز هذه دورا حاسما في تعزيز بيئة تطوير متناغمة وفعالة للمجتمع بأكمله.