كتابة ملحق WordPress بسيط ، دروس للمبتدئين

محتويات المقالة

أساسيات يجب معرفتها قبل إنشاء البرنامج المساعد WordPress

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

كيفية تسمية البرنامج المساعد WordPress

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

يجب أن يكون اسم المكون الإضافي فريدًا لتجنب التعارض مع المكونات الإضافية الأخرى. للتأكد من أن اسمك فريد ، يمكنك إجراء بحث على Google عن الاسم. بالإضافة إلى ذلك ، يمكنك البحث في أدلة المكونات الإضافية المختلفة بما في ذلك مستودع مكونات WordPress .

لتسمية أي مكون إضافي ، يتعين علينا إنشاء ملف مكون إضافي واحد على الأقل (ملف PHP الرئيسي) ، والذي يقدم لنا القسم التالي.

كيفية إنشاء ملفات البرنامج المساعد

يمكن أن يتكون المكون الإضافي من ملف PHP واحد أو ملفات متعددة بناءً على ما تم تصميمه للقيام به. الملف الأكثر أهمية هو ملف PHP الرئيسي ، وهو ما يعادل index.php و index.html في قوالب WordPress وتصميمات HTML على التوالي.

يوصى بأن يقوم مطورو WordPress بتسمية ملف المكون الإضافي الرئيسي الخاص بهم بعد المكون الإضافي الخاص بهم عن طريق الاصطلاح. على سبيل المثال ، ملف البرنامج المساعد الرئيسي لمكوِّن إضافي يسمى WP Renym plugin سيكون wp-renym.php . في حالة إضافة فاصل في اسمك ، استخدم فقط الواصلات (-) بين الكلمات بدلاً من الشرطات السفلية (_).

كما ذكرنا أعلاه ، يمكن إنشاء مكون إضافي من ملف واحد أو عدة ملفات (الصور ، JavaScript ، اللغة ، ملفات CSS ، إلخ). في كلتا الحالتين ، يجب أن تعيش ملفات المكونات الإضافية في دليل واحد. لذلك بالنسبة للمكونات الإضافية المسماة WP Renym ، سيتم وضع ملف wp-renym.php في مجلد wp-renym . يمكن إضافة مجلدات فرعية إضافية داخل مجلد البرنامج المساعد الرئيسي لاحتواء وتنظيم الملفات الأخرى.

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

إضافة رأس ملف إلى ملف PHP الرئيسي

عند تسمية المكون الإضافي الخاص بك ، يجب عليك إضافة تفاصيل أخرى مثل الوصف والإصدار والترخيص واسم المؤلف – بشكل أساسي كل ما سيظهر أسفل وبجانب المكون الإضافي في شاشة مكونات WordPress – رأس المكون الإضافي. لهذا ، يجب عليك استخدام رأس معلومات البرنامج المساعد القياسي أعلى ملف PHP الرئيسي. هذا ما يبدو عليه العنوان النموذجي:

/*
Plugin Name: Name of your plugin
Plugin URI:  http://link to your plugin homepage
Description: Describe what your plugin is all about in a few short sentences
Version:     1.0
Author:      Your name (Yay! Here comes fame... )
Author URI:  http://link to your website
License:     GPL2 etc
License URI: http://link to your plugin license
*/

كل معلمة في الرأس أعلاه تشرح نفسها بنفسها ، لذا لن أخوض في التفاصيل. ما عليك سوى التأكد من تضمين http: // أو https: // ذي الصلة عند كتابة المكون الإضافي وعنوان URI للمؤلف وإلا فلن تعمل الروابط.

اتبع العنوان الخاص بك بمعلومات الترخيص التالية إذا كنت ستستخدم ترخيص GPL2 أو ترخيصًا متوافقًا مع GPL2 :

/* Copyright YEAR PLUGIN_AUTHOR_NAME (email : your email address)
(Plugin Name) is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.
 
(Plugin Name) is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with (Plugin Name). If not, see (http://link to your plugin license).
*/

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

الآن بعد أن غطينا الأساسيات ، دعنا نكتب مكونًا إضافيًا بسيطًا لبرنامج WordPress يؤدي وظيفتين أساسيتين (لكنهما أنيقان):

استبدل الكلمات في المحتوى الخاص بك باختيارك للكلمات
أضف ملاحظة “شكرًا لك على قراءة هذا البرنامج التعليمي …” في نهاية كل منشور بالمدونة.

كيفية كتابة ملحق WordPress بسيط – WP Renym

في هذا القسم ، سنكتب رمزًا للمكوِّن الإضافي WP Renym الذي أذكره طوال الوقت.

ماذا تحتاج:

محرر الكود المفضل لديك (مثل Notepad ++ و SublimeText )
متصفح لرؤية المكون الإضافي الخاص بك في العمل (مثل Chrome )
تثبيت WordPress يعمل

تسمية البرنامج المساعد الخاص بنا

أولاً ، قمنا بفحص مستودع المكونات الإضافية لـ WordPress وقمنا ببحث Google عن اسمنا ؛ كان WP Renym مجانيًا. كان خياري الأولي هو WP Rename ولكنه تم أخذه بالفعل.

جارٍ الانتقال … افتح ملفًا جديدًا في محرر التعليمات البرمجية ، وأضف الكود التالي في الأعلى بعد فتح المكون الإضافي باستخدام <؟ php :

/*
Plugin Name: WP Renym
Plugin URI:  http://link to your plugin homepage
Description: This plugin replaces words with your own choice of words.
Version:     1.0
Author:      Freddy Muriuki
Author URI:  http://link to your website
License:     GPL2 etc
License URI: https://link to your plugin license

Copyright YEAR PLUGIN_AUTHOR_NAME (email : your email address)
(Plugin Name) is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.
 
(Plugin Name) is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with (Plugin Name). If not, see (http://link to your plugin license).
*/

احفظ الملف كملف wp-renym.php في مجلد wp-renym. إذا لم يكن لديك المجلد بالفعل ، فقم بإنشائه. سيكون wp-renym.php ملف PHP الرئيسي.

إضافة وظائف

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

function renym_wordpress_typo_fix( $text ) {
	return str_replace( 'wordpress', 'WordPress', $text );
}
add_filter( 'the_content', 'renym_wordpress_typo_fix' );

renym_wordpress_typo_fix هو الاسم الفريد الذي قدمناه لوظيفتنا . عند إضافة وظائف جديدة ، لا تبدأها أبدًا بـ wp_ – وهذا لمنع أي عدم توافق في المستقبل مع وظائف كود WordPress التي تستخدم جميعها البادئة wp_ .

تأخذ دالة PHP (نص $) كوسيط ، وتعيد السلسلة الأولى “wordpress” محل السلسلة الثانية “WordPress”.

لقد أضفنا عامل تصفية (add_filter) إلى المكون الإضافي الخاص بنا لإخبار وظيفتنا ( renym_wordpress_typo_fix ) بالعمل على النص الذي حددناه ، والذي يمثل في هذه الحالة محتوى المنشور بالكامل (the_content).

لاستبدال أكثر من كلمة واحدة (ربما ترغب في تعديل كلمات متعددة عبر مدونتك أو استخدام المكون الإضافي كعامل تصفية بسيط للألفاظ النابية) ، استبدل الكود أعلاه بالشفرة التالية:

function renym_content_replace( $content ) {
	$search  = array( 'wordpress', 'goat', 'Easter', '70', 'sensational' );
	$replace = array( 'WordPress', 'coffee', 'Easter holidays', 'seventy', 'extraordinary' );
	return str_replace( $search, $replace, $content );
}
add_filter( 'the_content', 'renym_content_replace' );

في الكود أعلاه ، اخترنا بالفعل الكلمات لتحل محل مثل wordpress ، و goat ، و Easter ، وما إلى ذلك ، كما اخترنا الكلمات البديلة مثل WordPress ، و Coffee ، و Easter Saturday ، إلخ. ونأمل أن يكون الرمز توضيحيًا إلى حد ما:

و renym_content_replace يأخذ وظيفة ($ محتوى) كوسيطة، يستبدل كل الكلمات الواردة في $ البحث مجموعة والعوائد عبارة المعدلة الآن لورد.
$ search يحتوي على جميع الكلمات المراد استبدالها
يحتوي $ replace على الكلمات البديلة
يقوم str_replace بأفضل ما يقوم به ، حيث يستبدل الكلمات الجديدة بالكلمات

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

إذا أكملت الخطوات المذكورة أعلاه ، فيمكن أن يحل المكون الإضافي الخاص بك محل جميع الكلمات المحددة بشكل فعال. الآن دعنا نضيف ملاحظة “شكرًا لك على قراءة هذا البرنامج التعليمي …” التي ستظهر أسفل كل مشاركة. أضف الكود التالي إلى ملف البرنامج المساعد الرئيسي ( renym_content_replace ) قبل قوس إغلاق PHP ( ؟> ) الذي يأتي في السطر الأخير:

function renym_content_footer_note( $content ) {
	$content .= '<footer class="renym-content-footer">Thank you for reading this tutorial. Maybe next time I will let you buy me a coffee! For more WordPress tutorials visit our <a href="http://wpexplorer.com/blog" title="WPExplorer Blog">Blog</a></footer>';
	return $content;
}
add_filter( 'the_content', 'renym_content_footer_note' );

احفظ التغييرات. و renym_content_footer_note وظيفة يضيف HTML العلامات إلى المعلمة محتوى $ وإرجاع قيمة جديدة في ووردبريس. لقد أضفنا أيضًا فئة تذييل إلى نصنا بحيث يمكن تنسيقه بسهولة لاحقًا.

لقد قمنا بتضمين عامل تصفية (add_filter) يخبر وظيفتنا بالعمل على النص الذي حددناه ، وهو محتوى المنشور كما هو ممثل بـ the_content.

ضغط المجلد الخاص بك

في هذه المرحلة ، يجب أن يبدو ملف wp-renym.php النهائي كما يلي:

<?php
/*
Plugin Name: WP Renym
Plugin URI:  http://link to your plugin homepage
Description: This plugin replaces words with your own choice of words.
Version:     1.0
Author:      Freddy Muriuki
Author URI:  http://link to your website
License:     GPL2 etc
License URI: https://link to your plugin license

Copyright YEAR PLUGIN_AUTHOR_NAME (email : your email address)
(Plugin Name) is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
any later version.
 
(Plugin Name) is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with (Plugin Name). If not, see (http://link to your plugin license).
*/

/*Use this function to replace a single word*/
function renym_wordpress_typo_fix( $text ) {
	return str_replace( 'wordpress', 'WordPress', $text );
}
add_filter( 'the_content', 'renym_wordpress_typo_fix' );

/*Or use this function to replace multiple words or phrases at once*/
function renym_content_replace( $content ) {
	$search  = array( 'wordpress', 'goat', 'Easter', '70', 'sensational' );
	$replace = array( 'WordPress', 'coffee', 'Easter holidays', 'seventy', 'extraordinary' );
	return str_replace( $search, $replace, $content );
}
add_filter( 'the_content', 'renym_content_replace' );

/*Use this function to add a note at the end of your content*/
function renym_content_footer_note( $content ) {
	$content .= '<footer class="renym-content-footer">Thank you for reading this tutorial. Maybe next time I will let you buy me a coffee! For more WordPress tutorials visit our <a href="http://wpexplorer.com/blog" title="WPExplorer Blog">Blog</a></footer>';
	return $content;
}
add_filter( 'the_content', 'renym_content_footer_note' );

?>

احفظ جميع التغييرات. قم بضغط مجلد WP Renym في أرشيف wp-renym.zip (على جهاز Mac يكون الأمر سهلاً مثل النقر بزر الماوس الأيمن وضغط الملف – وأعتقد أنه مشابه جدًا على جهاز الكمبيوتر). فقط تأكد من حفظ ملفك كملحق .ZIP وإلا فلن يتم تثبيت المكون الإضافي.