کدهای کوتاه

کدهای کوتاه

سایر بخش های سری آموزشی " ایجاد افزونه وردپرس "

بررسی اجمالی

به خاطر اضافه شدن لایه های امنیتی بیشتر به وردپرس ، شما اجازه اضافه کردن کدهای پی اچ پی (php) به یک نوشته را ندارید .
این مورد از خراب شدن و از دسترس خارج شدن سایت کاربران وردپرس جلوگیری می کند .

با این حال شاید شما نیاز داشته باشید که به کاربران اجازه دهید تا یکسری محتوای داینامیک که شامل کد های پی اچ پی هستند را ، در سایت وردپرسی خود اجرا کنند .

برای اعمال این قابلیت در وردپرس از کدهای کوتاه (shortcode) استفاده می شود .

یک کد کوتاه شبیه یک ماکرو است که می تواند با یک دستورالعمل تعدادی کار را انجام دهد .
به طور خلاصه ، یک کد کوتاه به عنوان یک میانبر برای نمایش محتوایی مانند یک گالری تصویر ، لیستی از نوشته ها ، یک فرم تماس و یا هر بخش داینامیک دیگری ، مورد استفاده قرار می گیرد .

از نسخه ۲.۵ وردپرس کدهای کوتاه پشتیبانی شدند .

در اینجا یک مثال ساده از یک کد کوتاه ، برای نمایش یک گالری در یک نوشته یا برگه ، را مشاهده می کنید :

[gallery]
در اینجا یک مثال دیگر از کد کوتاهی را می بینید که شامل چند خاصیت نیز می باشد .

[gallery id="1" size="medium"]

 

دستورالعمل های اضافی (یا خاصیت های کد کوتاه) هم در داخل براکت های کد کوتاه قرار دارند .

برای اضافه کردن یک کد کوتاه به نوشته یا برگه در ویرایشگر وردپرس(قسمت ویژوال و یا متنی فرقی ندارد) ، کافیست فقط کد کوتاه را مانند مثال های بالا بنویسید .
چنانچه شما از یک کد کوتاه با خاصیت های زیاد می خواهید استفاده کنید ، بهتر است آن را توسط مستندات ارائه شده توسط توسعه دهنده کد کوتاه ایجاد و سپس با کپی کردن و چسباندن آن در ویرایشگر از صحت ساختار آن مطمئن شوید .

 

چرا کدهای کوتاه ؟

کدهای کوتاه یک روش با ارزش برای نگهداری محتوا به صورت تمیز و پرمعنا هستند که به کاربران وردپرس اجازه می دهند بدون داشتن دانش برنامه نویسی آن محتوا را به شکل دلخواه خود به نمایش در بیاورند .
به عنوان مثال زمانی که کاربر پایانی استفاده کننده از کد کوتاه ، می خواهد توسط آن یک گالری را در سایت خود به نمایش درآورد ، می تواند با حداقل داده های ممکن شیوه نمایش گالری تصویر را مشخص کند .

یک مزیت کلیدی کدهای کوتاه :
هیچ نشانه گذاری به محتوای نوشته یا برگه توسط کدهای کوتاه اضافه نمی شود . به این معنی که هیچ استایل و کد اضافی به محتوای کد کوتاه اضافه نمی شود و هر زمان که بخواهید می توانید آنها را اضافه کنید .

 

کدهای کوتاه همچنین می توانند پارامترهایی داشته باشند ، که به کاربران این امکان را می دهند که برای هر نمونه از کد کوتاه یک رفتار متفاوت را انتخاب کنند .

 

کدهای کوتاه توکار (کدهای کوتاه موجود در هسته وردپرس)

به صورت پیش فرض ، وردپرس کدهای کوتاه زیر را پیشنهاد می دهد :
[caption]: در بر گرفتن یک محتوای دلخواه توسط عنوان

[gallery]: نمایش یک گالری از تصاویر

[audio]: درج و پخش فایل صوتی

[video]: درج و پخش فایل تصویری

[playlist]: نمایش مجموعه ای از فایل های صوتی و تصویری

 

اضافه کردن کد کوتاه

در ساده ترین حالت ،  API کد کوتاه شامل ثبت اسم کد کوتاه و تابع فراخوان آن ، با استفاده از تابع add_shortcode()   می باشد .
با اینکار شما به کاربران پایانی (End user) خود اجازه می دهید که از توابع پی اچ پی در محتوای نوشته ها یا برگه ها استفاده کنند ، البته به صورت امن تر و محافظت شده تر .

 

پارامترها

تابع add_shortcode()   می تواند ۳ پارامتر دریافت کند :
$atts   : یک آرایه انجمنی در صورت داشتن خاصیت و یک رشته خالی در صورت نداشتن هیچ خاصیتی
$content   : محتوای دربرگرفته شده . در صورتی که کد کوتاه قرار است پیرامون یک محتوا قرار گیرد .
$tag   : برچسب فعلی کد کوتاه . مفید برای توابع فراخوانی به اشتراک گذاری شده

 

بهترین تمرین های کد کوتاه

در اینجا چند تمرین عالی برای کار با کدهای کوتاه را به شما نشان می دهیم .
۱- برگشت دادن خروجی و البته نه چاپ کردن آن . کدهای کوتاه در اصل یک نوع فیلتر هستند ، بنابراین ارسال مستقیم به خروجی و یا تغییر متغیرهای عمومی در آنها می تواند باعث بروز حفره های امنیتی در افزونه شود .
۲- نام های کدکوتاه را ، جهت جلوگیری از تداخل با سایر افزونه ها ، با یک پیشوند خاص تعیین کنید .
۳- داده های ورودی را پاکسازی کنید و داده های خروجی را با تکنیک فرار (Escaping) امن کنید .
۴- کاربران افزونه را ، توسط یک مستندات مرتب و ساخت یافته در مورد خاصیت های کد کوتاه خود ، راهنمایی کنید .

۱۳۹۶/۴/۱۷ ۱۵:۴۵:۵۶

درباره نویسنده:

هدف ما در تیم راهنمای وردپرس ارائه خدمات به علاقه مندان در حوزه وب و بخصوص وردپرس و در نهایت ایجاد کسب و کار و به ثمر رسیدن ایده های شما دوستان خلاق میباشد.

نظر شما چیست