توضیحات
Plugin Check ابزاری برای آزمایش این است که آیا افزونه شما استانداردهای مورد نیاز برای مخزن افزونههای WordPress.org را برآورده میکند یا خیر. با این افزونه میتوانید اکثر بررسیهای مورد استفاده برای ارسالهای جدید را اجرا کنید و بررسی کنید که آیا افزونه شما الزامات را برآورده میکند.
علاوه بر این، این ابزار تخلفات یا نگرانیهای مربوط به بهترین شیوههای توسعه افزونه، از الزامات اولیه مانند استفاده صحیح از توابع بینالمللیسازی تا بهترین شیوههای دسترسیپذیری، عملکرد و امنیت را علامتگذاری میکند.
بررسیها را میتوان با استفاده از رابط کاربری مدیریت وردپرس یا WP-CLI اجرا کرد:
- برای بررسی یک افزونه با استفاده از مدیریت وردپرس، لطفاً به منوی ابزارها > Plugin Check بروید. برای دسترسی به آن صفحه باید بتوانید افزونهها را در سایت خود مدیریت کنید.
- برای بررسی یک افزونه با استفاده از WP-CLI، لطفاً از دستور
wp plugin checkاستفاده کنید. برای مثال، برای بررسی افزونه «Hello Dolly»:wp plugin check hello.php- توجه داشته باشید که بهطور پیشفرض هنگام استفاده از WP-CLI، تنها بررسیهای استاتیک قابل اجرا هستند. برای اینکه بررسیهای زمان اجرا (Runtime) را نیز شامل کنید، در حال حاضر یک راه حل موقت با استفاده از آرگومان
--requireدر WP-CLI لازم است تا فایلcli.phpرا به صورت دستی در دایرکتوری بررسیکننده افزونه قبل از بارگذاری وردپرس فراخوانی کنید. برای مثال:wp plugin check hello.php --require=./wp-content/plugins/plugin-check/cli.php - شما میتوانید از مسیر یا نشانی (URL) دلخواه برای بررسی یک افزونه استفاده کنید. به عنوان مثال، برای بررسی یک افزونه از طریق نشانی:
wp plugin check https://example.com/plugin.zipیا برای بررسی یک افزونه از یک مسیر:wp plugin check /path/to/plugin
- توجه داشته باشید که بهطور پیشفرض هنگام استفاده از WP-CLI، تنها بررسیهای استاتیک قابل اجرا هستند. برای اینکه بررسیهای زمان اجرا (Runtime) را نیز شامل کنید، در حال حاضر یک راه حل موقت با استفاده از آرگومان
بررسیها در چندین دستهبندی گروهبندی شدهاند تا بتوانید نوع بررسیهایی را که میخواهید روی یک افزونه اجرا کنید، شخصیسازی نمایید.
به خاطر داشته باشید که این افزونه جایگزینی برای فرآیند بررسی دستی نیست، اما به شما کمک میکند تا روند تأیید افزونه خود برای مخزن افزونههای WordPress.org را سرعت بخشید و همچنین به شما کمک میکند تا از برخی اشتباهات رایج جلوگیری کنید.
حتی اگر قصد ندارید افزونه خود را در مخزن WordPress.org میزبانی کنید، پیشنهاد میشود که از Plugin Check استفاده کنید تا افزونه شما از الزامات پایه و بهترین شیوههای افزونههای وردپرس پیروی کند.
ابزار نامگذاری افزونه
افزونه Plugin Check اکنون شامل یک ابزار «نامگذاری افزونه» مبتنی بر هوش مصنوعی است (قابل دسترسی از طریق ابزارها > نامگذاری Plugin Check) که به نویسندگان افزونه کمک میکند تا نامهای افزونه را قبل از ارسال ارزیابی کنند. این ابزار موارد زیر را بررسی میکند:
- شباهت به افزونههای موجود در مخزن WordPress.org
- تداخل احتمالی علائم تجاری با برندهای شناختهشده
- انطباق با دستورالعملهای نامگذاری افزونه وردپرس
- مشکلات نامگذاری عمومی یا بیش از حد کلی
نامگذار افزونه، بازخورد فوری با پیشنهادهای عملی ارائه میدهد و به شما کمک میکند نامی واضح، منحصر به فرد و مطابق با سیاستها انتخاب کنید که در فهرست افزونهها متمایز باشد. این ویژگی به وردپرس ۷.۰+ و رابطهای هوش مصنوعی پیکربندی شده نیاز دارد.
مهم: ابزار «نامگذاری افزونه» تنها جنبه راهنمایی دارد و قطعی نیست. تمام تصمیمات مربوط به نام افزونه مشروط به بررسی نهایی و تأیید توسط بازبینهای تیم افزونههای WordPress.org است.
ابزار بررسی SVN
Plugin Check همچنین یک ابزار بررسی SVN نیز دارد (از طریق ابزارها > بررسی SVN افزونه در دسترس است) که مخزن SVN وردپرس.org یک افزونه را برای فایلها، پوشهها و آرشیوهای zip غیرمنتظره بررسی میکند. این کار به نویسندگان افزونه و بازبینیکنندگان کمک میکند تا مطمئن شوند پیش از انتشار یا پس از آن، فقط فایلهای موردنظر در پوشههای trunk، tags و assets افزونه وجود دارند.
بررسیهای بازبینیشده توسط هوش مصنوعی
زمانی که تحلیل هوش مصنوعی فعال باشد، Plugin Check میتواند نتایج انتخابشده را بررسی کند تا به شناسایی مثبتهای کاذب احتمالی کمک کند. مشکلات مرتبط گروهبندی شده و با پرامپتهایی متناسب با نوع بررسی تحلیل میشوند و از کدهای اطراف بهعنوان زمینه استفاده میشود. بازبینی هوش مصنوعی نتایج اصلی را حذف یا تغییر نمیدهد، بلکه یک خلاصهٔ اضافی اضافه میکند که مشخص میکند کدام یافتهها ممکن است پیش از انجام هر اقدامی به بررسی انسانی نیاز داشته باشند.
نصب
نصب از داخل وردپرس
- به مسیر افزونهها > افزودن بروید.
- عبارت Plugin Check را جستجو کنید.
- افزونه Plugin Check را نصب و فعال کنید.
نصب دستی
- کل پوشه
plugin-checkرا در دایرکتوری/wp-content/plugins/بارگذاری کنید. - به بخش افزونهها بروید.
- افزونه Plugin Check را فعال کنید.
سوالات متداول
-
کجا میتوانم در توسعه افزونه مشارکت کنم؟
-
تمام فرآیند توسعه این افزونه از طریق GitHub انجام میشود؛ هرگونه مشکل یا درخواست تغییر (Pull Request) باید در آنجا ارسال شود.
-
اگر افزونه چیزی که صحیح است را به عنوان «خطا» یا «هشدار» گزارش دهد چه؟
-
ما تلاش میکنیم افزونه را بهگونهای بنویسیم که موارد مثبت کاذب را به حداقل برساند، اما اگر موردی پیدا کردید، لطفاً آن را در مخزن GitHub گزارش دهید. برای برخی موارد مثبت کاذب خاص، مانند مواردی که توسط PHPCodeSniffer شناسایی میشوند، ممکن است بتوانید کد را حاشیهنویسی (Annotate) کنید تا مشکل خاصی را برای یک خط مشخص نادیده بگیرد.
-
چرا چیزی را به عنوان بد علامتگذاری میکند؟
-
این ابزار لزوماً چیزهای «بد» را علامتگذاری نمیکند. Plugin Check طراحی شده است تا روشی (هرچند ناکامل) برای آزمایش انطباق با دستورالعملهای بررسی افزونه و همچنین بهترین شیوههای اضافی توسعه افزونه در زمینههای دسترسیپذیری، عملکرد، امنیت و سایر زمینهها باشد. همه افزونهها ملزم به رعایت این دستورالعملها نیستند. هدف ابزار بررسی این است که اطمینان حاصل شود افزونههای بارگذاری شده در مخزن مرکزی افزونههای WordPress.org با آخرین استانداردهای افزونه وردپرس مطابقت دارند و در طیف گستردهای از سایتها کار میکنند.
بسیاری از سایتها از افزونههای سفارشی استفاده میکنند و این کاملاً اشکالی ندارد. اما افزونههایی که برای استفاده عموم در انواع مختلف سایتها در نظر گرفته شدهاند، باید حداقل سطح خاصی از قابلیتها را داشته باشند تا از عملکرد صحیح در محیطهای مختلف اطمینان حاصل شود. دستورالعملهای بررسی افزونه با در نظر گرفتن این هدف ایجاد شدهاند.
این بررسیکننده افزونه کامل نیست و هرگز نخواهد بود. این تنها ابزاری برای کمک به نویسندگان افزونه یا هر کس دیگری است که میخواهد افزونه خود را توانمندتر کند. تمام افزونههای ارسال شده به WordPress.org توسط تیمی از کارشناسان به صورت دستی بررسی میشوند. بررسیکننده خودکار افزونه تنها به عنوان یک ابزار مفید در نظر گرفته شده است، نه یک معیار سنجش مطلق.
-
آیا یک افزونه برای تأیید شدن در مخزن افزونههای WordPress.org باید تمام بررسیها را بگذراند؟
-
برای تأیید شدن در مخزن افزونههای WordPress.org، یک افزونه معمولاً باید تمام بررسیهای دسته «مخزن افزونه» (Plugin repo) را با موفقیت بگذراند. سایر بررسیها اضافی هستند و ممکن است گذراندن آنها الزامی نباشد.
در هر صورت، گذراندن بررسیهای این ابزار احتمالاً به دستیابی به فرآیند بررسی روانتر افزونه کمک میکند، اما تضمینی برای تأیید شدن افزونه در مخزن افزونههای WordPress.org نیست.
