wp stubs

ต้นขั้ว WordPress

repo นี้มี stub wordpress ที่สร้างโดยอัตโนมัติเพื่อใช้กับเครื่องมือวิเคราะห์แบบคงที่

คำถามที่พบบ่อย

• ทำไมถึงเป็นเช่นนี้แทนที่จะเป็น "<แทรกออกจากโครงการที่นี่>"?

วัตถุประสงค์ของโครงการนี้คือ:

• มี WP หลายเวอร์ชันในสาขา/เวอร์ชันเดียวกัน
• ไม่มี ต้นขั้วสำหรับ globals แต่มีต้นขั้วสำหรับค่าคงที่
• มีวิธีการ "แทนที่" super-simple " โดยการประกาศสตับในไฟล์ fixtures.php เป็นไปได้ที่จะแทนที่การประกาศ WordPress สำหรับฟังก์ชั่นคลาสและอินเทอร์เฟซ ด้วยวิธีนี้มันเป็นเรื่องง่ายที่จะแก้ไข docblocks ที่ไม่ถูกต้องใน WordPress และใช้บล็อก DOC "ขั้นสูง" ที่รองรับโดยนักวิเคราะห์แบบคง

วิธีการทำงานนี้

ทุกวันเวิร์กโฟลว์การกระทำของ GitHub เรียก WP.org API เพื่อค้นหาเวอร์ชัน WordPress ใหม่

หากพบเวอร์ชันใหม่มันจะสร้างและบันทึกต้นขั้วสำหรับพวกเขา (โดยใช้ https://github.com/php-stubs/generator) ในขณะเดียวกันก็อัปเดตสตับ "ล่าสุด"

วิธีใช้

การใช้งานหลักสำหรับเครื่องมือวิเคราะห์แบบคงที่เช่นสดุดี:

วิธีที่ 1: รับเวอร์ชัน WordPress ทั้งหมด

ขั้นตอน:

1. ต้องการโครงการนี้ ( inpsyde/wp-stubs ) ในคุณสมบัติ "require-dev" ของนักแต่งเพลงของคุณ
2. สร้างไฟล์กำหนดค่า psalm.xml (ดูเอกสาร)
3. ในการกำหนดค่าสดุดีเพิ่มบรรทัดเหล่านี้:

   < stubs >
       < file name = " vendor/inpsyde/wp-stubs/stubs/latest.php " />
   </ stubs >

คุณสามารถแทนที่ latest.php ด้วยเวอร์ชัน WP เฉพาะ ดูเวอร์ชันที่มีอยู่ในไดเรกทอรี /stubs

หมายเหตุ : ในโฟลเดอร์นั้นหมายเลขเวอร์ชันสองหลักเช่น 5.9 ไม่ได้หมายถึง WordPress เวอร์ชัน 5.9 แต่ ล่าสุด ในซีรี่ส์ 5.9.* ดังนั้นหากคุณใช้นักแต่งเพลงเพื่อต้องการ WordPress และมีข้อกำหนดเช่น 5.9.* การใช้ไฟล์ stubs/5.9.php Stubs จะตรงกับเวอร์ชันที่ติดตั้งในปัจจุบัน

โฟลเดอร์ "Stubs" มีต้นขั้วหลายรุ่นเพื่อให้คุณสามารถเลือกได้ แต่มันก็เป็นไปได้ที่จะมีสคริปต์ CI ที่โหลดเวอร์ชันที่แตกต่างกันเพื่อทดสอบกับต้นขั้วที่แตกต่างกัน

อย่างไรก็ตามขนาดแพ็คเกจอาจมีขนาดใหญ่มากและหากไม่ได้แยกออกจากการวิเคราะห์ของ IDE ก็อาจส่งผลกระทบต่อประสิทธิภาพของ IDE

วิธีที่ 2: รับเวอร์ชันเฉพาะ

สิ่งที่ต้องทำล่วงหน้า:

ใน composer.json ของคุณ json ประกาศที่เก็บเช่นนี้:

{
  "repositories" : [
    {
      "type" : " composer " ,
      "url" : " https://raw.githubusercontent.com/inpsyde/wp-stubs/main " ,
      "only" : [
        " inpsyde/wp-stubs-versions "
      ]
    }
  ]
}

หมายเหตุสำหรับนักพัฒนา INPSyde : องค์กร Inpsyde ในแพ็คเกจส่วนตัวสะท้อนพื้นที่เก็บข้อมูลข้างต้นดังนั้นสำหรับที่เก็บส่วนตัวของ Inpsyde สิ่งนี้ไม่ จำเป็น ต้องพิจารณานักบรรจุ composer.json ส่วนตัว

ขั้นตอน:

1. ต้องใช้โครงการ "เวอร์ชัน" ในคุณสมบัติ "require-dev" นักแต่งเพลงของคุณเช่น { "require": { "inpsyde/wp-stubs-versions": "dev-latest" } } (หมายเหตุว่าชื่อแพ็คเกจมี -versions ต่อท้ายอย่างไร)
2. สร้างไฟล์กำหนดค่า psalm.xml (ดูเอกสาร)
3. ในการกำหนดค่าสดุดีเพิ่มบรรทัดเหล่านี้:

   < stubs >
       < file name = " vendor/inpsyde/wp-stubs-versions/latest.php " />
   </ stubs >

การใช้วิธีการนี้เวอร์ชันล่าสุดจะเป็นการดาวน์โหลดนักแต่งเพลงรุ่น เดียว

ข้อกำหนดขั้นต่ำ

รหัสที่สร้างต้นขั้วต้องใช้ PHP 8.0+ อย่างไรก็ตามเมื่อบริโภคแพ็คเกจไม่มีข้อกำหนดขั้นต่ำนอกเหนือจากความสามารถในการเรียกใช้ WordPress

ใบอนุญาต

ที่เก็บนี้เป็นซอฟต์แวร์ฟรีและเปิดตัวภายใต้เงื่อนไขของใบอนุญาต MIT ดูใบอนุญาตสำหรับใบอนุญาตที่สมบูรณ์