در روزهای اول یادگیری وردپرس، هر بار که می‌خواستم یک تابع یا هوک را در کد استفاده کنم، باید بین چند سایت و مستندات می‌گشتم. تا اینکه یک Cheat Sheet فارسی از توابع پرکاربرد پیدا کردم و از آن به بعد، سرعتم دو برابر شد. سال‌ها بعد که روی پروژه‌های بزرگ کار می‌کردم، این عادت ماند: هر جا که استفاده مکرر از یک سری توابع را می‌دیدم، یک Cheat Sheet اختصاصی برای همان پروژه می‌ساختم. این مقاله درباره همین ابزار ساده ولی پربازده است.

Cheat Sheet دقیقاً چیست؟

Cheat Sheet، یک سند فشرده است که پرکاربردترین توابع، دستورات، هوک‌ها یا قواعد یک زبان یا سیستم را در یک صفحه جمع می‌کند. برای وردپرس، Cheat Sheet معمولاً شامل توابع هسته، هوک‌های پرکاربرد، شورت‌کدها و تنظیمات پایه است. تعریف کاملتر در Cheat Sheet چیست و چرا مفید است آمده است.

نکته کلیدی: Cheat Sheet جایگزین مستندات رسمی نیست. هدفش این است که کارهای روزمره را سریع‌تر کند، نه این‌که همه‌چیز را یاد بدهد. اگر با ساختار کلی وردپرس آشنا نیستید، ابتدا وردپرس چیست و ساختار هسته وردپرس را بخوانید.

Cheat Sheet، نقشه راه کوتاه است؛ برای قدم‌زدن در مسیر، هنوز به مستندات کامل نیاز دارید.

چرا Cheat Sheet سرعت توسعه را بالا می‌برد؟

سه دلیل اصلی:

  1. کاهش زمان جستجو: به‌جای گشتن در مستندات، پارامترهای تابع را در یک نگاه می‌بینید.
  2. کاهش خطای فراموشی: اسم دقیق تابع یا ترتیب پارامترها، در Cheat Sheet واضح است.
  3. یادگیری سریع‌تر: برای تازه‌کارها، Cheat Sheet نقشه اولیه را می‌سازد.

تجربه من: در پروژه‌های تیمی، اضافه‌کردن یک Cheat Sheet اختصاصی پروژه به مستندات، سرعت کار اعضای جدید را به‌شدت بالا می‌برد. به‌خصوص در پروژه‌هایی که از هوک‌های وردپرس و توابع ضروری وردپرس استفاده زیادی می‌شود.

معیارهای انتخاب Cheat Sheet مناسب

پیش از انتخاب، پنج معیار را بررسی کنید:

معیارتوضیح
به‌روز بودنمتناسب با آخرین نسخه وردپرس و PHP
پوشش موضوعیهمه نیازهای اصلی شما را پوشش دهد
ساختار واضحدسته‌بندی منطقی، جستجوپذیر
قابل چاپ یا ذخیرهPDF یا HTML سبک
زبانفارسی یا انگلیسی، بسته به تیم شما

نکته مهم: بهترین Cheat Sheet، آن است که تیم شما واقعاً از آن استفاده می‌کند، نه آن که کامل‌ترین باشد. یک Cheat Sheet کوچک و کاربردی، از یک دایرةالمعارف بزرگ که کسی سراغش نمی‌رود، ارزشمندتر است.

Cheat Sheet های وردپرس

برای وردپرس، چند Cheat Sheet شناخته‌شده وجود دارد که هرکدام تمرکز متفاوتی دارند:

  • WordPress Core Cheat Sheet: تمرکز روی توابع هسته وردپرس. مناسب توسعه‌دهنده‌های قالب و افزونه.
  • WordPress Hooks Cheat Sheet: فهرست کامل هوک‌های action و filter. مناسب توسعه افزونه.
  • WordPress Template Tags Cheat Sheet: تمرکز روی توابع نمایش محتوا در قالب.
  • WP-CLI Cheat Sheet: دستورات خط فرمان برای مدیریت وردپرس.

در پروژه‌های خودم، از هر چهار دسته استفاده می‌کنم. برای شروع پروژه جدید، Cheat Sheet هوک‌ها و توابع قالب، ارزشمندترین هستند. اگر با Boilerplate کار می‌کنید، مقایسه بهترین Boilerplate های وردپرس را هم ببینید.

Cheat Sheet هوک‌ها و توابع وردپرس

هوک‌ها، قلب توسعه وردپرس هستند. Cheat Sheet هوک‌ها به‌طور معمول شامل این دسته‌هاست:

  1. هوک‌های اجرا: init، wp_loaded، template_redirect.
  2. هوک‌های مدیریت: admin_init، admin_menu، admin_enqueue_scripts.
  3. هوک‌های قالب: wp_head، wp_footer، wp_enqueue_scripts.
  4. هوک‌های محتوا: the_content، the_title، save_post.
  5. هوک‌های کاربران: user_register، wp_login، profile_update.

فهرست تفصیلی این هوک‌ها را در هوک‌های وردپرس چیست و توابع ضروری وردپرس آورده‌ام. اگر می‌خواهید کدهای کوتاه و کاربردی بنویسید، پست قطعه کد وردپرس چیست را ببینید.

Cheat Sheet هوک‌ها، ابزار روزمره توسعه‌دهنده است؛ به‌جای حفظ کردن، مرجع همراه شما می‌شود.

Cheat Sheet های PHP

در پروژه‌های وردپرس، PHP زبان اصلی است. Cheat Sheet های PHP مفید عبارتند از:

  • PHP Functions Cheat Sheet: توابع رشته، آرایه، تاریخ و فایل.
  • PHP OOP Cheat Sheet: کلاس‌ها، اینترفیس‌ها، ترِیت‌ها.
  • PHP Regex Cheat Sheet: الگوهای Regular Expression.
  • PHP PDO Cheat Sheet: کار با دیتابیس به‌صورت امن.

مقایسه تفصیلی این‌ها در بهترین Cheat Sheet های PHP آمده است.

Cheat Sheet های JavaScript

در پروژه‌های مدرن وردپرس، جاوااسکریپت نقش مهمی دارد. Cheat Sheet های کاربردی:

  • JavaScript ES6+ Cheat Sheet: arrow functions، destructuring، spread.
  • DOM Manipulation Cheat Sheet: querySelector، addEventListener.
  • Fetch API Cheat Sheet: درخواست‌های HTTP.
  • Async/Await Cheat Sheet: کار با Promise و async.

مقایسه در بهترین Cheat Sheet های JavaScript آمده است.

Cheat Sheet های CSS و HTML

در فرانت‌اند، Cheat Sheet های CSS و HTML کمک زیادی می‌کنند:

  • CSS Flexbox Cheat Sheet: پرکاربردترین ابزار چیدمان مدرن.
  • CSS Grid Cheat Sheet: چیدمان پیچیده‌تر.
  • CSS Selectors Cheat Sheet: انتخابگرهای پیشرفته.
  • HTML5 Semantic Cheat Sheet: تگ‌های معنایی.

ساخت Cheat Sheet اختصاصی

در پروژه‌های بزرگ، بهترین Cheat Sheet، آن است که خودتان می‌سازید. روش من:

  1. پایش پروژه: در طول توسعه، به توابع و هوک‌هایی که زیاد استفاده می‌کنید توجه کنید.
  2. جمع‌آوری در یک فایل Markdown: ساده، قابل جستجو، قابل ویرایش.
  3. افزودن نمونه کد: برای هر تابع، یک نمونه کوچک بنویسید.
  4. اشتراک با تیم: در ریپازیتوری پروژه نگه دارید.
  5. به‌روزرسانی: هر ماه یک بار بازبینی کنید.

در یکی از پروژه‌های بزرگ، این Cheat Sheet اختصاصی، زمان آموزش اعضای جدید تیم را از دو هفته به سه روز کاهش داد. اثرش غیرقابل انکار بود.

اشتباهات رایج

  • جمع‌آوری بدون استفاده: بعضی افراد چندین Cheat Sheet دانلود می‌کنند و هیچ‌وقت به آن‌ها نگاه نمی‌کنند.
  • Cheat Sheet قدیمی: با تغییر نسخه وردپرس، بعضی توابع حذف یا منسوخ می‌شوند. حتماً به‌روز بمانید.
  • جایگزینی با مستندات: Cheat Sheet، مکمل است، نه جانشین.
  • فراموش‌کردن تیم: Cheat Sheet اختصاصی پروژه که با تیم به اشتراک گذاشته نشود، نصف ارزشش را از دست می‌دهد.
  • نادیده گرفتن زبان: Cheat Sheet انگلیسی خوب است، ولی اگر تیم شما فارسی‌زبان است، یک Cheat Sheet فارسی می‌تواند کارآمدتر باشد.

تصمیم نهایی

Cheat Sheet وردپرس، یک ابزار ساده با اثر بزرگ است. اگر توسعه‌دهنده وردپرس هستید، انتخاب درست Cheat Sheet می‌تواند سرعت روزمره شما را چند برابر کند. توصیه من: از یک Cheat Sheet شناخته‌شده شروع کنید، سپس در طول زمان یک نسخه اختصاصی برای پروژه‌های خودتان بسازید. تجربه‌ام این است: توسعه‌دهندگانی که یک Cheat Sheet شخصی و به‌روز دارند، هم سریع‌تر کد می‌زنند، هم کمتر اشتباه می‌کنند. اگر Cheat Sheet اختصاصی خودتان را دارید یا در یک پروژه از Cheat Sheet جالبی استفاده کرده‌اید، در دیدگاه‌ها بنویسید. 📋