場所

wp-includes/deprecated.php

書式

function get_settings($option);

説明

get_settingsはWordPressのオプションを取得するための関数です。データベースのwp_optionsから対応する値を読み取ってきます。

string $option

取得するオプションの名前

サンプルコード

<?php

echo get_settings('home');

?>

homeという名前を持つオプションを呼び出しています。

実行結果

http://bluedb.org/wordpress

取得可能なオプション

admin_email

管理者のメールアドレス

blogname

ブログのタイトル

blogdescription

ブログのサブタイトル

blog_charset

ブログの文字コード。UTF-8とか

date_format

日付のフォーマット

default_cateogry

記事を投稿するときのデフォルトのカテゴリー

home

ブログのURL

siteurl

WordPressのサイトのURL

template

現在のテーマの名前

start_of_week

週始めをいつからにするか。日曜日か月曜日か。

upload_path

ファイルをアップロードするときの場所。任意指定可能。

posts_per_page

トップページやカテゴリーやアーカイブなどの1画面に表示する投稿の最大値。

posts_per_rss

rssに出力する投稿の最大値

場所

wp-includes/general-template.php

書式

function wp_title($sep = ‘»’, $display = true);

説明

string $sep

セパレーター。タイトルの前につく印。初期値は「&rqauo;」

string $display

trueでタイトルを出力。falseで出力を抑制します。

サンプルコード

<?php
wp_title("[セパレータ]", true);
?>

実行結果

[セパレータ] WordPress Hacks

<?php
$username = "データベースへのログイン名";
$password = "データベースへのログインパスワード";
$dbname = "データベースの名前";

$con = mysql_connect("localhost" , $username , $password);

if (empty($con))
    die("connection failed");

mysql_select_db($dbname);

$sql = "select count(*) from wp_posts where post_type='post'";

$result = mysql_query($sql,$con);

$rows = mysql_fetch_array($result);

echo $dbname . ": " . $rows[0] . "<br>";

mysql_close($con);
?>

テーブルにwp_postsを指定し、whereでpost_typeにpostを指定します。

wp-includes/plugin.php

書式

function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) ;

説明

add_action()は任意の関数をactionに登録するための関数です。add_action()のAPIは

string $tag

$function_to_addの関連付け先の名前

callback $function_to_add

フィルター関数の名前

int $priority

フィルターの優先度。どのフィルターを先に実行するかを指定する。

int $accepted_args

フィルター関数が受け取り可能な引数の数

返り値

フィルターの登録が成功したらture、失敗したらfalseを返します。

サンプルコード

<?php

function test1($arg)
{
    print("[" . $arg . "]\r\n");
}

function test2($arg)
{
    print("+" . $arg . "+\r\n");
}

add_action("bluedb_demo", test1);
add_action("bluedb_demo", test2);

do_action("bluedb_demo", "Hello World");

?>

bluedb_demoという名前のタグに関数test1と関数test2を追加し、do_action()で実行しています。

実行結果

[Hello World]
+Hello World+

wp-includes/plugin.php

書式

function do_action($tag, $arg = ”);

説明

$tagに関連付けられたactionを実行します。$argはactionを実行する際のの引数です。1つのactionには1つのtag、複数の関数が登録されています。

string $tag

$function_to_addの関連付け先の名前

array $arg

引数の配列

サンプルコード

<?php

function test1($arg)
{
    print("[" . $arg . "]\r\n");
}

function test2($arg)
{
    print("+" . $arg . "+\r\n");
}

add_action("bluedb_demo", test1);
add_action("bluedb_demo", test2);

do_action("bluedb_demo", "Hello World");

?>

bluedb_demoという名前のタグに関数test1と関数test2を追加し、do_action()で実行しています。

実行結果

[Hello World]
+Hello World+

$tag

任意のアクションに関連付けられたtag。文字列。

$arg

引数。可変長。

という感じです。返り値は持たないみたいです。ソースコードを以下に示します。

function do_action($tag, $arg = '') {
    global $wp_filter, $wp_actions;

    if ( is_array($wp_actions) )
        $wp_actions[] = $tag;
    else
        $wp_actions = array($tag);

    $args = array();
    if ( is_array($arg) && 1 == count($arg) && is_object($arg[0]) ) // array(&$this)
        $args[] =& $arg[0];
    else
        $args[] = $arg;
    for ( $a = 2; $a < func_num_args(); $a++ )
        $args[] = func_get_arg($a);

    merge_filters($tag);

    if ( !isset($wp_filter[$tag]) )
        return;

    do{
        foreach( (array) current($wp_filter[$tag]) as $the_ )
            if ( !is_null($the_['function']) )
                call_user_func_array($the_['function'], array_slice($args, 0, (int) $the_['accepted_args']));

    } while ( next($wp_filter[$tag]) !== false );

}

処理をざっくりと説明すると、

1. $argを配列に展開
2. $wp_filter[$tag]に登録されている関数名をpriority順に読み出す
3. 読み出した関数名と展開した$argをphp関数であるcall_user_func_array()で関数を呼ぶ

という感じになっています。

サンプルコード

do_action('init');

これはwp-settings.phpの一番最後に記述されているコードです。initというactionを呼び出しています。init tagに対する登録は前回のサンプルコードで示した通りです。このdo_action(’init’)でWordPressが使用するさまざまなライブラリの初期化関数を一度に呼び出しています。

string $tag

$function_to_addの関連付け先の名前

callback $function_to_add

フィルター関数の名前

int $priority

フィルターの優先度。どのフィルターを先に実行するかを指定する。

int $accepted_args

フィルター関数が受け取り可能な引数の数

返り値

フィルターの登録が成功したらture、失敗したらfalseを返します。

となっています。これを見て分かるとおり、add_action()と前回述べたadd_filter()は全く同じです。

function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
    add_filter($tag, $function_to_add, $priority, $accepted_args);
}

サンプル

add_action('init', 'kses_init');

これはwp-includes/kses.phpに記述されている処理です。kses.phpはコメントのタグをチェックするためのライブラリです。ここではinitというtagにkses_initという関数を登録しています。このように、initというtagにはさまざまなライブラリの初期化関数が登録されています。

「Googleで自分のホームページ内を検索」を利用してフォームのHTMLを取得します。

<form method="get" action="http://www.google.co.jp/custom" target="_top"a>
<table width="100%">
<tr><td>
<a href="http://www.google.com/">
<img src="http://www.google.com/logos/Logo_25wht.gif" alt="Google" align="middle" style="border:none;"></img></a>
<input type="text" name="q" size="40" maxlength="255" value="" id="sbi"></input>
<input type="submit" name="sa" value="サイト内を検索" id="sbb"></input>
<input type="hidden" name="domains" value="bluedb.org"></input>
<input type="hidden" name="sitesearch" value="bluedb.org" id="ss1"></input>
<input type="hidden" name="client" value="pub-5778690733142083"></input>
<input type="hidden" name="forid" value="1"></input>
<input type="hidden" name="ie" value="UTF-8"></input>
<input type="hidden" name="oe" value="UTF-8"></input>
<input type="hidden" name="hl" value="ja"></input>
</td>
</tr>
</table>
</form>

このソースコードを自分好みに整形してテーマのheader.phpやsidebar.phpに貼り付ければ自分のサイトだけを検索してくれるGoogle検索フォームの完成です。

<center>
<form method="get" action="http://www.google.co.jp/custom" target="_top"a>
<table>
<tr><td>
<input type="text" name="q" size="25" maxlength="255" value="" id="sbi"></input>
<input type="hidden" name="domains" value="bluedb.org/wordpress"></input>
<input type="hidden" name="sitesearch" value="bluedb.org/wordpress" id="ss1"></input>
<input type="hidden" name="client" value="pub-5778690733142083"></input>
<input type="hidden" name="forid" value="1"></input>
<input type="hidden" name="ie" value="UTF-8"></input>
<input type="hidden" name="oe" value="UTF-8"></input>
<input type="hidden" name="hl" value="ja"></input>
</td>
</tr>
<tr>
<td>
<input type="submit" name="sa" value="サイト内を検索" id="sbb"></input>
</td>
</tr>
</table>
</form>
</center>

メリット

WordPressの検索はMySQLの機能を使っているだけなのでデータの量が増えれば増えるほど検索が遅くなります。それに対してGoogleの検索エンジンを利用することでデータの量が増えても高速に検索ができ、WordPressが動作しているサーバーへの負担もかけません。

デメリット

データベースの更新にはGoogleのSpiderが見に来る時間に依存します。つまり結構遅いです。また、検索結果がGoogleのページになってしまうという問題点もあります。ただ、フレームを利用したりすることであたかもWordPressで検索したかのように表示することもできなくはありません。

やり方は簡単です。サイドバーに次のようなコードを書き込みます。

<?php query_posts('&pagename=sitesearch'); ?>
<?php the_post(); ?>
<?php the_content(); ?>

query_posts(’&pagename=sitesearch’)はどういう意味かというと、Post Slugがsitesearchであるデータに対してクエリをするというものです。つまり、ページを作成するときにPost Slugにsitesearchを指定しておけばここで読み込むことができます。

the_post()はデータを呼び出すための関数です。これは必ず呼ばなければなりません。

the_content()はページのテキストデータです。

以上でページの埋め込みは終了です。

注意

sidebarがコンテンツよりも前にある場合にquery_posts()関数がコンテンツのthe_post()を壊してしまう可能性があります。なのでこのテクニックはサイドバーはコンテンツを読み込んだ後に用いることをお勧めします。

まずはfilterを追加するための関数であるadd_filter()関数から読みたいと思います。

フィルターはデータベースとブラウザの間に入り、テキストを変換するための機構です。例えばデータベースから読み込んだデータをフィルターで加工してブラウザーに表示したり、ブラウザーから入力されたデータを加工してデータベースに突っ込んだりします。PHPの関数に関連付けられたプラグインはフィルターAPIを用いてテキストデータを加工します。add_filterのAPIは

string $tag

$function_to_addの関連付け先の名前

callback $function_to_add

フィルター関数の名前

int $priority

フィルターの優先度。どのフィルターを先に実行するかを指定する。

int $accepted_args

フィルター関数が受け取り可能な引数の数

返り値

フィルターの登録が成功したらture、失敗したらfalseを返します。

add_filter()関数のソースコードは以下の通りです。

function add_filter($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
    global $wp_filter, $merged_filters;

    $idx = _wp_filter_build_unique_id($tag, $function_to_add, $priority);
    $wp_filter[$tag][$priority][$idx] = array('function' => $function_to_add, 'accepted_args' => $accepted_args);
    unset( $merged_filters[ $tag ] );
    return true;
}

まず、_wp_filter_build_unique_id()関数で追加するフィルター関数へのユニークIDを作成します。$function_to_addが関数名の場合には$function_to_addがそのままユニークIDになります。

$wp_filterは3次元配列に成っており,$tag、$priority、$idx（ユニークID）を添え字としてフィルター関数へのポインタを保持します。

サンプルコード

add_filter('the_content', 'wptexturize');

the_content()関数にwptexturize()関数をフィルターとして登録しています。wptexturize()関数はwp-includes/formatting.phpに記述されており、コンテンツを整形する機能を持っています。