poet

กวี

Poet นำเสนอประเภทการโพสต์ตามการกำหนดค่าอย่างง่าย อนุกรมวิธาน จานสีตัวแก้ไข หมวดหมู่บล็อก รูปแบบบล็อก และการลงทะเบียน/แก้ไขบล็อก

คุณสมบัติ

• ประเภทการโพสต์แบบตายตัวและการลงทะเบียนอนุกรมวิธาน การแก้ไข และการยกเลิกการลงทะเบียนที่ขับเคลื่อนโดย Extended CPT
• การกำหนดค่าจานสีตัวแก้ไขที่ง่ายดาย รวมถึงการสนับสนุน webpack-palette-plugin ในตัว
• บล็อกที่ลงทะเบียนจะถูกเรนเดอร์โดยใช้ Laravel Blade ที่ส่วนหน้า
• รูปแบบบล็อกที่ลงทะเบียนสามารถกำหนดเนื้อหาโดยใช้ Laravel Blade ได้เช่นกัน
• เพิ่มหมวดหมู่บล็อกเพิ่มเติมโดยไม่มีอะไรมากไปกว่าทาก
• ย้ายรายการเมนูผู้ดูแลระบบหลักไปที่เมนูย่อย Tools โดยใช้เพจ Slug

ความต้องการ

• ปราชญ์ >= 10.0
• PHP >= 7.4
• ผู้แต่ง

การติดตั้ง

ติดตั้งผ่านนักแต่งเพลง:

$ composer require log1x/poet

เริ่มต้นใช้งาน

เริ่มต้นด้วยการเผยแพร่ไฟล์การกำหนดค่า Poet โดยใช้ Acorn:

$ wp acorn vendor:publish --provider= " Log1xPoetPoetServiceProvider " 

การใช้งาน

การลงทะเบียนประเภทการโพสต์

การกำหนดค่าทั้งหมดที่เกี่ยวข้องกับ Poet อยู่ใน config/poet.php ที่นี่คุณจะพบตัวอย่างประเภทการโพสต์หนังสือที่กำหนดค่าล่วงหน้าด้วยการตั้งค่าทั่วไปบางประการ:

 ' post ' => [
    ' book ' => [
        ' enter_title_here ' => ' Enter book title ' ,
        ' menu_icon ' => ' dashicons-book-alt ' ,
        ' supports ' => [ ' title ' , ' editor ' , ' author ' , ' revisions ' , ' thumbnail ' ],
        ' show_in_rest ' => true ,
        ' has_archive ' => false ,
        ' labels ' => [
            ' singular ' => ' Book ' ,
            ' plural ' => ' Books ' ,
        ],
    ],
],

ในรูปแบบที่ง่ายที่สุด คุณสามารถสร้างประเภทโพสต์ได้โดยเพียงแค่ส่งสตริง:

 ' post ' => [
    ' book ' ,
],

หากต้องการแก้ไขประเภทโพสต์ที่มีอยู่ ให้ปฏิบัติเสมือนว่าคุณกำลังสร้างประเภทโพสต์ใหม่โดยส่งเฉพาะตัวเลือกการกำหนดค่าที่คุณต้องการเปลี่ยนแปลง:

 ' post ' => [
    ' post ' => [
        ' labels ' => [
            ' singular ' => ' Article ' ,
            ' plural ' => ' Articles ' ,
        ],
    ],
],

นอกจากนี้ยังสามารถยกเลิกการลงทะเบียนประเภทโพสต์ที่มีอยู่ได้โดยเพียงแค่ส่ง false :

 ' post ' => [
    ' book ' => false ,
],

โปรดทราบว่าการโพสต์ในตัวบางประเภท (เช่น การโพสต์) ไม่สามารถยกเลิกการลงทะเบียนตามอัตภาพได้

สำหรับตัวเลือกการกำหนดค่าเพิ่มเติมสำหรับประเภทการโพสต์ โปรดดู:

• register_post_type()
• register_extended_post_type()

หมายเหตุ : อย่าซ้อนการกำหนดค่าในคีย์ config เหมือนที่แสดงในเอกสารประกอบ CPT แบบขยาย

การลงทะเบียนอนุกรมวิธาน

การลงทะเบียนอนุกรมวิธานจะคล้ายกับประเภทโพสต์ เมื่อดูใน config/poet.php คุณจะเห็น Genre Taxonomy ที่มาพร้อมกับประเภทการโพสต์หนังสือเริ่มต้น:

 ' taxonomy ' => [
    ' genre ' => [
        ' links ' => [ ' book ' ],
        ' meta_box ' => ' radio ' ,
    ],
],

ตัวเลือกการกำหนดค่าที่เกี่ยวข้องมากที่สุดคือ links ซึ่งกำหนดประเภทโพสต์ที่อนุกรมวิธานเชื่อมต่ออยู่ หากไม่มีการระบุลิงก์ ระบบจะ post โดยค่าเริ่มต้น

หากต้องการดูไฟล์เก็บถาวรสำหรับอนุกรมวิธานประเภท ให้คัดลอกเทมเพลต Blade ชื่อ archive.blade.php ไปยังไฟล์ใหม่ชื่อ taxonomy-genre.blade.php

ในรูปแบบที่ง่ายที่สุด คุณสามารถส่งผ่านสตริงได้ ตัวอย่างด้านล่างนี้จะสร้างอนุกรมวิธานของหัวข้อสำหรับประเภทโพสต์โพสต์:

 ' taxonomy ' => [
    ' topic ' ,
],

เช่นเดียวกับประเภทการโพสต์ หากต้องการแก้ไขอนุกรมวิธานที่มีอยู่ เพียงส่งเฉพาะตัวเลือกการกำหนดค่าที่คุณต้องการเปลี่ยนแปลง:

 ' taxonomy ' => [
    ' category ' => [
        ' labels ' => [
            ' singular ' => ' Section ' ,
            ' plural ' => ' Sections ' ,
        ],
    ],
],

เช่นเดียวกับประเภทโพสต์ คุณสามารถยกเลิกการลงทะเบียนอนุกรมวิธานที่มีอยู่ได้อย่างง่ายดายเพียงส่งผ่าน false :

 ' taxonomy ' => [
    ' post_tag ' => false ,
    ' category ' => false ,
],

สำหรับตัวเลือกการกำหนดค่าเพิ่มเติมสำหรับการจัดหมวดหมู่ โปรดดู:

• register_taxonomy()
• register_extended_taxonomy()

หมายเหตุ : อย่าซ้อนการกำหนดค่าในคีย์ config เหมือนที่แสดงในเอกสารประกอบ CPT แบบขยาย

การลงทะเบียนบล็อก

Poet มอบวิธีง่ายๆ ในการลงทะเบียนบล็อก Gutenberg กับโปรแกรมแก้ไขโดยใช้มุมมอง Blade ที่มาพร้อมกันเพื่อเรนเดอร์บล็อกที่ส่วนหน้า

บล็อกถูกลงทะเบียนโดยใช้ namespace/label ที่กำหนดเมื่อลงทะเบียนบล็อกกับเอดิเตอร์

หากไม่มีการระบุเนมสเปซ โดเมนข้อความของธีมปัจจุบันจะถูกนำมาใช้แทน

การลงทะเบียนบล็อกในกรณีส่วนใหญ่นั้นทำได้ง่ายเพียง:

 ' block ' => [
    ' sage/accordion ' ,
],

การสร้างมุมมองแบบบล็อก

เมื่อพิจารณาจาก block sage/accordion มุมมอง Blade ที่มาพร้อมกับคุณจะอยู่ที่ views/blocks/accordion.blade.php

มุมมองแบบบล็อกมีตัวแปรดังต่อไปนี้:

• $data – วัตถุที่มีข้อมูลบล็อก
• $content – ​​สตริงที่มีเนื้อหา InnerBlocks ส่งคืน null เมื่อว่างเปล่า

ตามค่าเริ่มต้น เมื่อตรวจสอบว่า $content ว่างเปล่าหรือไม่ ก็จะถูกส่งผ่านวิธีการเพื่อลบแท็กและช่องว่างทั้งหมดก่อนที่จะประเมิน สิ่งนี้ทำให้มั่นใจได้ว่าตัวแก้ไขจะขยายตัวเหมือน nbsp; หรือแท็ก <p></p> ว่างจะไม่ทำให้ $content คืนค่า true เสมอเมื่อใช้ในเงื่อนไข

หากคุณไม่ต้องการให้มีพฤติกรรมนี้ในบล็อกใดบล็อกหนึ่ง เพียงลงทะเบียนเป็นอาร์เรย์:

 ' block ' => [
    ' sage/accordion ' => [ ' strip ' => false ],
],

หากคุณต้องการลงทะเบียนคุณลักษณะของบล็อกโดยใช้ PHP บนบล็อกใดบล็อกหนึ่ง เพียงส่งแอตทริบิวต์ในอาร์เรย์เมื่อลงทะเบียน:

 ' block ' => [
    ' sage/accordion ' => [
        ' attributes ' => [
            ' title ' => [
                ' default ' => ' Lorem ipsum ' ,
                ' type ' => ' string ' ,
            ],
        ],
    ],
],

พิจารณาบล็อกหีบเพลงที่ลงทะเบียนด้วยแอตทริบิวต์ title และ className มุมมองของคุณอาจมีลักษณะดังนี้:

<div class="wp-block-accordion {{ $ data -> className ?? '' }}">
  @ isset ( $ data -> title )
    <h2>{!! $ data -> title !!}</h2>
  @endisset

  <div>
    {!! $ content ?? ' Please feed me InnerBlocks. ' !!}
  </div>
</div>

การลงทะเบียนหมวดหมู่บล็อก

Poet ช่วยให้การลงทะเบียน แก้ไข และยกเลิกการลงทะเบียนหมวดหมู่บล็อก Gutenberg เป็นเรื่องง่าย เมื่อดูในการกำหนดค่า คุณจะเห็นตัวอย่างที่มีการใส่ความคิดเห็นไว้สำหรับหมวดหมู่คำกระตุ้นการตัดสินใจ:

 ' block_category ' => [
    ' cta ' => [
        ' title ' => ' Call to Action ' ,
        ' icon ' => ' star-filled ' ,
    ],
],

ซึ่งจะส่งผลให้มีหมวดหมู่บล็อกที่มีกระสุนเป็น cta เมื่อหมวดหมู่บล็อกของคุณได้รับการลงทะเบียนแล้ว คุณต้องลงทะเบียนบล็อกให้กับทากก่อน หมวดหมู่จึงจะปรากฏในตัวแก้ไข

ในรูปแบบที่ง่ายที่สุด คุณสามารถส่งสตริง:

 ' block_category ' => [
    ' my-cool-blocks ' ,
],

ซึ่งจะส่งผลให้หมวดหมู่ my-cool-blocks แปลงกระสุนเป็นตัวพิมพ์โดยอัตโนมัติ

คุณยังสามารถระบุชื่อโดยส่งค่าไปที่ทากของคุณ:

 ' block_category ' => [
    ' my-cool-blocks ' => ' Best Blocks, World. ' ,
],

เช่นเดียวกับประเภทการโพสต์และอนุกรมวิธาน การแก้ไขหมวดหมู่บล็อกที่มีอยู่จะเหมือนกับการลงทะเบียน:

 ' block_category ' => [
    ' layouts ' => ' Sections ' ,
    ' common ' => [ ' icon ' => ' star-filled ' ],
],

คุณสามารถยกเลิกการลงทะเบียนหมวดหมู่บล็อกที่มีอยู่ได้โดยเพียงแค่ส่ง false :

 ' block_category ' => [
    ' common ' => false ,
],

การลงทะเบียนรูปแบบบล็อก

กวียังสามารถลงทะเบียน Block Patterns ให้กับคุณได้ ด้วยมุมมอง Blade ที่เป็นตัวเลือกสำหรับเนื้อหา

รูปแบบจะถูกลงทะเบียนโดยใช้ namespace/label ที่กำหนดเมื่อลงทะเบียนรูปแบบกับโปรแกรมแก้ไข

หากไม่มีการระบุเนมสเปซ โดเมนข้อความของธีมปัจจุบันจะถูกนำมาใช้แทน

การลงทะเบียนบล็อกในกรณีส่วนใหญ่นั้นทำได้ง่ายเพียง:

 ' block_pattern ' => [
    ' sage/hero ' => [
        ' title ' => ' Page Hero ' ,
        ' description ' => ' Draw attention to the main focus of the page, and highlight key CTAs ' ,
        ' categories ' => [ ' all ' ],
    ],
],

คุณสามารถลงทะเบียนเนื้อหาจริงสำหรับรูปแบบได้ที่นี่เช่นกัน โดยใช้คีย์ content หรือปล่อยว่างไว้เพื่อใช้มุมมองเบลดที่สอดคล้องกัน

 ' block_pattern ' => [
    ' sage/fake-paragraph ' => [
        ' title ' => ' Fake Paragraph ' ,
        ' description ' => ' Filler content used instead of actual content for testing purposes ' ,
        ' categories ' => [ ' all ' ],
        ' content ' => ' <!-- wp:paragraph --><p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ratione nulla culpa repudiandae nisi nostrum et, labore earum repellendus porro, mollitia voluptas quam? Modi sint tempore deleniti nesciunt ab, perferendis et.</p><!-- /wp:paragraph --> ' ,
    ],
],

การสร้างมุมมองรูปแบบ

เมื่อพิจารณาถึง block sage/fake-paragraph หากไม่มีการกำหนดคีย์ content มุมมอง Blade ที่มาพร้อมกันของคุณจะอยู่ที่ views/block-patterns/fake-paragraph.blade.php

มุมมองรูปแบบบล็อกนี้อาจมีลักษณะดังนี้:

<!-- wp:paragraph -->
<p> Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ratione nulla culpa repudiandae nisi nostrum et, labore earum repellendus porro, mollitia voluptas quam? Modi sint tempore deleniti nesciunt ab, perferendis et.</p>
<!-- /wp:paragraph -->

การลงทะเบียนหมวดหมู่รูปแบบบล็อก

สามารถเพิ่มหมวดหมู่รูปแบบบล็อกได้ด้วยโค้ดต่อไปนี้ในการกำหนดค่ากวี:

 ' block_pattern_category ' => [
    ' all ' => [
        ' label ' => ' All Patterns ' ,
    ],
],

คุณสามารถระบุคุณสมบัติหมวดหมู่ทั้งหมด เช่น label ตามคู่มือตัวแก้ไขบล็อก

หมายเหตุ: ในปัจจุบัน หากไม่มีหมวดหมู่รูปแบบบล็อกเลย แท็บรูปแบบบล็อกในตัวแก้ไขจะหยุดทำงานเมื่อคลิก

การลงทะเบียนจานสีตัวแก้ไข

กวีพยายามทำให้การลงทะเบียนจานสีกับโปรแกรมแก้ไขง่ายขึ้นเล็กน้อย โดยไม่จำเป็นต้องมีมาร์กอัปอาเรย์ที่เข้มงวดและเปราะบางเช่นนี้

แม้ว่าคุณจะสามารถส่งผ่านอาเรย์ดังกล่าวได้โดยตรง แต่คุณยังสามารถลงทะเบียนสีได้โดยเพียงแค่ส่งทากไปพร้อมกับสีแล้วปล่อยให้กวีจัดการส่วนที่เหลือ

 ' palette ' => [
    ' red ' => ' #ff0000 ' ,
    ' blue ' => ' #0000ff ' ,
],

นอกเหนือจากการส่งอาร์เรย์แล้ว Poet ยังยอมรับไฟล์ JSON ที่มีชุดสีของคุณอีกด้วย โดยทั่วไปกวีจะค้นหาไฟล์นี้ในรูปแบบ dist/ ตามค่าเริ่มต้น

 ' palette ' => ' colors.json ' ,

หากคุณใช้ปลั๊กอิน Palette Webpack คุณสามารถส่งค่า true เพื่อใช้ palette.json ที่สร้างขึ้นโดยอัตโนมัติระหว่างการ build ได้

 ' palette ' => true ,

รายงานข้อผิดพลาด

หากคุณพบข้อบกพร่องใน Poet โปรดเปิดปัญหา

มีส่วนร่วม

การสนับสนุนไม่ว่าจะเป็นผ่านการประชาสัมพันธ์ การรายงานปัญหา หรือการแนะนำแนวคิด เป็นสิ่งที่ได้รับการสนับสนุนและชื่นชม

ใบอนุญาต

กวีมีให้ภายใต้ใบอนุญาต MIT