這是用於提供外掛名稱及外掛開發者外部連結的簡易 WordPress 社群外掛。
這個外掛會使用短代碼方式將 XHTML 清單插入任何文章/頁面。如需自訂清單顯示結果,使用格式引數便能輸出指定的清單內容格式。此外,這個外掛的短代碼也包含一個能顯示未啟用外掛的格式引數。
主要功能
- 提供能進行格式化並顯示外掛資訊的簡易範本
- 範本提供的標籤可以自動連結文字內容
- 可選擇要輸出哪些外掛資料
- 如果需要,可以同時顯示未啟用的外掛及已啟用的外掛
- 自動將外掛較長的內容說明限制為指定長度,甚至在輸出時移除 Emoji 表情符號
- 經過快取的輸出結果,能提供非常快的回應
- 提供一個可顯示網站外掛數量的獨立短代碼
感謝 Matej Nastran 所開發的 My plugins,這是 Plugins List 的開發構想來源。
外掛圖示由極富設計品味的 Janki Rathod 所設計。
前往這個外掛的 GitHub 存放庫,便能取得開發中的最新程式碼、了解規劃中的改進功能及外掛已知問題。
開始使用
如果要顯示網站上已安裝並啟用的外掛清單,請在文章或頁面插入以下短代碼:
<ul>[plugins_list]</ul>
短代碼中可以使用 format
引數及數個預先定義的標籤自訂並格式化輸出結果。範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}"]
這個外掛的短代碼可用的標籤如下,標籤必須由雙括號括住…
Title
:外掛名稱PluginURI
:外掛網址Author
:外掛開發者名稱AuthorURI
:外掛開發者網址Version
:外掛版本號碼Description
:外掛內容說明RequiresWP
:WordPress 核心程式最低版本需求RequiresPHP
:PHP 最低版本需求LinkedTitle
:會自動連結至對應網址的外掛名稱LinkedAuthor
:外掛開發者名稱,會連結至對應的個人資料頁面Active
:依據外掛的使用狀態將外掛顯示為 [已啟用] 或 [未啟用]
外掛列表可以透過 CSS 將顯示結果樣式化,僅需在 format
引數或其周圍的元素放置 class
或 id
屬性。
使用 HTML 程式碼
使用 HTML 程式碼可以將外掛清單格式化,但這可能會導致視覺化編輯器的剖析錯誤,甚至會讓不需要出現的字元 (例如異常的執行個體段落標籤) 顯示在清單輸出中。如果真的要使用 HTML 程式碼,強烈建議使用雙括號取代 <
及 >
將 HTML 標籤括住。這個外掛會在輸出前修正這個問題,但這也代表視覺化編輯器不會試著解譯 HTML 程式碼。
範例如下:
<ul>[plugins_list format="{{li}}{{LinkedTitle}} - {{LinkedAuthor}}{{/li}}"]</ul>
這些雙括號字元會在輸出時進行修正,然後在頁面上輸出正確的項目清單。
如果使用區塊編輯器,並且需要以 HTML 程式碼包裝短代碼,請參考下方詳細資訊以了解最佳做法。
其他參數
啟用及未啟用的外掛
預設僅會顯示已啟用的外掛,但是使用 show_active
、show_inactive
及 show_recent
參數便能變更這項設定。
舉例來說,以下短代碼可以同時顯示已啟用及未啟用的外掛:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" show_inactive=true]
如果僅想顯示未啟用的外掛,請使用以下短代碼:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" show_inactive=true show_active=false]
如果想顯示之前曾啟用、但目前未啟用的外掛,請使用以下短代碼:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" show_inactive=false show_active=false show_recent=true]
連結目標及 nofollow
依照預設,搜尋引擎機器人會前往外掛清單提供的連結;如果想讓將這些連結標示為 nofollow
(不前往),僅需加入 nofollow=true
參數。範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" nofollow=true]
也可以要求瀏覽器在新分頁/新視窗中開啟連結。範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" target="_blank"]
限制內容說明長度
這個外掛提供2 個參數限制內容說明長度,便不會讓內容說明長度太長。使用者可以使用 words
或 chars
參數,便能指定字數或字元數的最大長度。範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" words=20]
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" chars=80]
雖然不建議麼做,但如果同時使用這 2 個參數,則會使用會使內容說明長度最短的參數。
依照預設,如果指定內容說明長度,結尾會加上省略符號。如果要變更這項預設值,使用者可以使用 end
參數並指定結尾的表示方式。範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" chars=80 end=" [More]"]
移除 Emoji 表情符號
如需移除外掛內容說明中的 Emoji 表情符號,使用 emoji
參數便能達成目的。這個參數的預設值為 true
,設定為 false
便能移除外掛內容說明中的 Emoji 表情符號。範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" emoji=false]
以開發者名稱排序
如果外掛清單輸出結果需要以開發者名稱排序而非以外掛名稱排序,請使用 by_author
參數。範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" by_author=true]
快取
依照預設,Plugins List 所產生的外掛清單會每 5 分鐘重新快取一次,確保盡可能不影響主機效能。如需變更這項預設設定,請使用 cache
參數並設定整數分鐘值;如果將這個參數值設定為 false
,便會關閉這個外掛的外掛清單頁面快取機制。
範例如下:
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" cache=60]
上列參數值會將頁面快取保留 1 小時 (60 分鐘),而下列設定則會關閉快取機制。
[plugins_list format="{{LinkedTitle}} ({{LinkedAuthor}}) - {{Description}}{{br/}}" cache=false]<h3>Using with the block editor</h3>
直接將短代碼插入區塊編輯器中不會產生任何問題,這會自動將短代碼新增至 [短代碼] 區塊中。請注意,如果需要使用 HTML 程式碼包裝短代碼,便會產生問題,解決方案是先新增 [短代碼] 區塊,然後加入以 HTML 程式碼包裝的短代碼,如此一來 HTML 程式碼便能如預期般執行。
外掛安裝數量
這個外掛還提供一個可以顯示網站外掛安裝數量的短代碼。只要將 [plugins_number]
插入文章或頁面,預設會傳回目前已啟用外掛的數量。
如需同時顯示啟用及未啟用的外掛數量…
[plugins_number inactive=true]
也可以指定僅顯示未啟用外掛的數量…
[plugins_number inactive=true active=false]
這個短代碼預設會將短代碼的執行結果進行快取。如需變更快取的分鐘數,請使用 cache
參數,而將參數值設定為 false
便能關閉快取。範例如下:
[plugins_number inactive=true cache=120]
這會將快取設定為保留 2 小時。