[WordPress] 外掛分享： functionsCapacitor

內容簡介

將 WordPress API 嵌入內容中。

您可以在文章、頁面或小工具內的參數使用相同的語法請求某些 WordPress API 函數。
functionsCapacitor 會將函數結果插入內容作為 HTML 輸出。

(*) 可查看 支援的函數
或條件標記。

功能

可安全地使用此外掛在 WordPress MU 或 WP MultiSite 上。
允許個性化內嵌輸出
每個功能。
簡單而強大的函數引數語法
以應用任何 WordPress API 選項。
使用魔法關鍵字的通用函數引數。
新增：使用WordPress 條件標記作為選項來顯示小工具。
結構化的原始碼以防止任何衝突。

使用 WordPress API 函數的三種方法：

使用短碼標籤的方法

在內容中插入類似 [fct function_name=”parameter1=value&parameter2=value”] 的標籤。

一個短碼標籤可以請求多個函數，輸入 [fct function_name1=”arguments” function_name2=”arguments”]。

使用小工具的方法

新增一個 functionsCapacitor 小工具，選擇一個函數，輸入函數參數，如 “parameter1=value&parameter2=value”（不含引號）。

可選：選擇一個支援的條件標記來決定在哪裡顯示小工具。

使用自訂欄位的方法

設置自訂欄位名稱為函數名稱，並將函數參數放入自訂欄位值中，例如 “parameter1=value&parameter2=value”（不含引號）。

結果始終插入在最後。
外掛優先級為 5。大多數外掛使用優先級 10。
如果顯示文章/頁面，則適用於此方法。

範例

熱門文章標籤的標籤雲，
插入 [fct wp_tag_cloud]
當前頁面的子頁面列表，
插入 [fct wp_list_pages=”title_li=&child_of=%postID%&depth=1″]
帶有節錄的分類最新文章列表，
插入 [fct wp_get_recent_posts=”category=X&fct:show_excerpt=1″]
其中 X 是分類 ID 編號。
不包含預設分類的分類列表，
插入 [fct wp_list_categories=”title_li=&exclude=%defaultcatID%”]

內嵌輸出

所有 functionsCapacitor 請求都會插入 <div class="functionsCapacitor">函數輸出</div>。
短碼方法可個性化主要容器，例如
[fct container=”HTML 標籤名稱” class=”類別（名稱）” style=”CSS 屬性” function1=”args” function2=”args”]。
將 container=”” 設為移除主要容器。

一些函數輸出是插入在內容最下方。

外掛標籤

開發者團隊

📦 歷史版本下載

0.80.90.9.20.9.30.9.40.9.50.9.6

原文外掛簡介

Back WordPress API to the content.

You can request some* functions of WordPress API with same syntax for arguments into your posts, pages, or widgets content.
functionsCapacitor will insert function result into your content as HTML output.
(*) see Supported functions
or conditional tags.
Features

Safe process to use this plugin on WordPress MU or WP MultiSite.
Allow to personalize Embedded output
for each functions.
Easy and powerfull Functions arguments syntax
to apply any WordPress API options.
Generic functions arguments with Magic keywords.
NEW: use WordPress conditional tags as option to display a widget.
Structured source-code to prevent any conflict.

Three methods to use WordPress API functions :
Method by shortcode tag
Insert a tag into your content like [fct function_name=”parameter1=value¶meter2=value”].
One shortcode tag can request several functions, input [fct function_name1=”arguments” function_name2=”arguments”].
Method with a widget
Add a functionsCapacitor widget, select a function, input function parameters like “parameter1=value¶meter2=value” (without quotes).
Optional: choose a supported conditional function to decide where to display your widget.
Method by custom fields
Set a custom field name with function name and put function arguments into custom field value like “parameter1=value¶meter2=value” (without quotes).

Result is always inserted at end.
Plugin has priority 5. Most plugins use priority 10.
This method is applied if post/page is displayed.

Examples

Tag cloud of popular posts tags,
insert [fct wp_tag_cloud]
List of children pages of current page,
insert [fct wp_list_pages=”title_li=&child_of=%postID%&depth=1″]
List of category’s recent posts with excerpts,
insert [fct wp_get_recent_posts=”category=X&fct:show_excerpt=1″]
with X equal category ID number
List of categories without default category,
insert [fct wp_list_categories=”title_li=&exclude=%defaultcatID%”]

Embedded output
Any functionsCapacitor request will insert

.
Shortcode method allow to personalize main container like
[fct container=”HTML tag name” class=”class(es) name(s)” style=”CSS properties” function1=”args” function2=”args”].
set container=”” to remove main container.
Some functions output were inserted with dedicated container like
function output
or

.
Personalize this container with Special functions parameters.
Functions arguments syntax
Follow these examples to setup your requests :

“parameter1=something¶meter2=25”,
parameter1 and parameter2 typed as strings.
“parameter1=something¶meter2=false”,
parameter2 typed as boolean.
“parameter1=¶meter2= ¶meter3=””,
any parameters equal empty string.
“parameter1= something ¶meter2=’ something ‘”,
parameter1 equal ‘something’,
parameter2 equal ‘ something ‘.
“parameter1=something¶meter2=array(‘something’,’something’)”,
parameter2 typed as an array of 2 strings.
“parameter1=something¶meter2=array(10,5,20)”,
parameter2 typed as an array of 3 integers.
“parameter1=something¶meter2=array(true,false)”,
parameter2 typed as an array of 2 booleans.

Not supported issues :

parameter’s value can’t contain “&” or “=” characters.
parameter’s value can’t contain an associative array like array(‘name’=>value,’name’=>value).
parameter’s value can’t contain an array of arrays.
parameter’s value can’t contain a PHP variable like $post->ID,
see Magic keywords.
parameter’s value can’t request a PHP or WordPress function.
parameter’s value can’t contain PHP source-code.

Magic keywords
Use these keywords to obtain variables values into your functions arguments :

%postID% => $post->ID,
ID of post or page where made the request :
related post/page into a shortcode,
or current post/page into a widget.
%postparent% => $post->post_parent,
ID of parent page where made the request.
%postauthor% => $post->post_author,
author ID of post where made the request.
%defaultcatID% => default_category,
ID of default category for newest posts.
%posttagIDs% => wp_get_post_tags(),
string of current post tags IDs as “1,2,3,…”
%posttagslugs% => wp_get_post_tags(),
string of current post tags slugs as “slug-name,slug-name,…”

You can use magic keywords into an array.
Example: wp_list_categories=”exclude=array(%defaultcatID%,1,2,…)”
Special functions parameters

fct:container to set HTML tag of function container.
Set “fct:container=”” to remove this container.
Each functions have a default container related to its output.
fct:container_id to set container “id” attribute.
fct:container_class to set container “class” attribute.
Function name as default.
Example with shortcode: [fct function_name=”fct:container_class=name¶m1=value¶m2=value”].
fct:container_style to set container “style” attribute.

functionsCapacitor not create a container if the API function still return a container.
See WordPress Codex to personalize them.
Supported functions

get_the_post_thumbnail()
with size=thumbnail|medium|large|post-thumbnail
or size name defined with add_image_size() into theme’s file functions.php.
get_the_tag_list()
with before=”&sep=’ ‘&after=” as default,
apply only on page or post,
rendered into DIV container
wp_get_archives()
with echo=0&format=html as default
wp_get_recent_posts()
rendered as list with UL container,
with exclude=%postID%&suppress_filters=false&post_status=publish&fct:perm=readable as default
(see bellow)
wp_list_authors()
with echo=0 as default
wp_list_bookmarks()
with echo=0 as default
wp_list_categories()
with echo=0 as default
wp_list_pages()
with echo=0 as default
wp_nav_menu()
with echo=false as default,
see Codex to setting its container
wp_tag_cloud()
with echo=0 as default,
format=flat|list only

See WordPress Codex about these functions and their arguments syntax.
Need you to support more functions, mail to [email protected]
wp_get_recent_posts()

if fct:perm=readable hide draft, future, pending, protected posts
but display private posts if user is allowed.
if fct:perm=” not output permalink of draft, future, pending, private posts.
set fct:show_excerpt=1|true to display posts excerpts.
set fct:show_date=1|true to display posts dates.
set fct:show_thumbnail=1|true to display post thumbnail,
with fct:thumbnail_size=thumbnail|medium|large|post-thumbnail
or size name defined with add_image_size() into theme’s file functions.php.
fct:show_thumbnail=true if fct:thumbnail_size is defined
display excerpt and thumbnail for draft, future, pending, private, and protected posts
but not create an excerpt from content.

Supported conditional functions

cat_is_ancestor_of()
check if current category is child of conditional argument.
in_category()
is_category()
is_front_page()
is_home()
is_page()
is_single()

See WordPress Conditional Tags about these functions and their arguments syntax.
Not canonical conditional functions
These functions are designed for this plugin only, not available elsewhere, and not documented into the WordPress Codex.

in_tree_of()
check if page, post, or category is descendant of conditional argument (or itself),
require argument as page or category numeric ID.
is_category_in_tree_of()
check if category is descendant of conditional argument (or itself),
require argument as category numeric ID.
is_page_descendant_of()
check if page is descendant of conditional argument,
require argument as page numeric ID.
is_page_in_tree_of()
check if page is descendant of conditional argument (or itself),
require argument as page numeric ID.
is_single_in_tree_of()
check if post is in descendant of conditional argument,
require argument as category numeric ID.

Conditional functions arguments syntax
Support only arguments as single value ; string, numeric, or magic keyword.

延伸相關外掛