カテゴリー: WordPress Plugin

[WordPress] API 追加するプラグインのスケルトン

<?php
/*
Plugin Name: My API
Version: 0.1-alpha
Description: 記事取得用 API
Author: wokamoto@digitalcube
Author URI: https://digitalcube.jp
Plugin URI: https://digitalcube.jp
Text Domain: my-api
Domain Path: /languages
Thx! http://firegoby.jp/archives/5309
License:
Released under the GPL license
http://www.gnu.org/copyleft/gpl.html
Copyright 2014 wokamoto (email : wokamoto1973@gmail.com)
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
// プラグインの有効化時/無効化時の処理を登録
register_activation_hook( __FILE__ , 'My_API::activation' );
register_deactivation_hook( __FILE__ , 'My_API::deactivation' );
// フックの登録
$my_api = My_API::get_instance();
$my_api->init();
class My_API {
private static $instance;
const OPTION_NAME_ACTIVATED = 'my-api_activated';
const API_ENDPOINT = 'api';
const API_VIEWS = 'api-template';
private function __construct() {}
public static function get_instance() {
if( !isset( self::$instance ) ) {
$c = __CLASS__;
self::$instance = new $c();
}
return self::$instance;
}
// フックの登録
public function init(){
// rewrite rule の追加
add_action('init', array($this, 'add_rewrite_endpoint'));
// 他のプラグインや管理者の操作によってflush_rewrite_rules()が発火した際にこのプラグイン用のrewrite ruleを再登録する
add_action('delete_option', array($this, 'delete_option'), 10, 1 );
// API 表示用
add_filter('query_vars', array($this, 'query_vars'));
add_action('template_redirect', array($this, 'template_redirect'));
}
// 有効化時の処理
static public function activation(){
update_option( self::OPTION_NAME_ACTIVATED, true );
flush_rewrite_rules();
}
// 無効化時の処理
static public function deactivation(){
delete_option( self::OPTION_NAME_ACTIVATED );
flush_rewrite_rules();
}
// delete_optionフックのコールバック関数
public function delete_option($option){
if ( 'rewrite_rules' === $option && get_option(self::OPTION_NAME_ACTIVATED) ) {
$this->add_rewrite_endpoint();
}
}
// rewrite rule の追加
public function add_rewrite_endpoint() {
add_rewrite_endpoint(self::API_ENDPOINT, EP_ROOT);
}
// query_vars の追加
public function query_vars($vars) {
$vars[] = self::API_ENDPOINT;
return $vars;
}
// API
public function template_redirect() {
global $wp_query;
if (is_object($wp_query) && isset($wp_query->query[self::API_ENDPOINT])) {
$api = preg_replace('/[^a-z0-9\-]*/', '', strtolower($wp_query->query[self::API_ENDPOINT]));
if (empty($api))
$api = 'default';
$api_template = sprintf('%s/%s/%s.php', dirname(__FILE__), self::API_VIEWS, $api);
nocache_headers();
header('Content-Type: application/json; charset='.get_option('charset'));
if ( file_exists($api_template) ) {
load_template($api_template);
} else {
status_header('404');
echo json_encode(array('meta' => array('code' => "404", "message" => "API Not Found")));
}
exit;
}
}
}

view raw
gistfile1.php
hosted with ❤ by GitHub

API が実際に返すデータはプラグインディレクトリのサブディレクトリ api-template の中に {api名}.php ってファイル書いて置いておいてね。
たとえば http://example.com/api/get-posts ってリクエストが来たら api-template/get-posts.php を読み込みます。

[WordPress] Contact Form 7 に独自ショートコードを追加

<?php
add_action('init', 'my_wpcf7_shortcode');
function my_wpcf7_shortcode(){
wpcf7_add_shortcode('my_shortcode', 'my_wpcf7_shortcode_handler', true);
}
function my_wpcf7_shortcode_handler( $tag ) {
$tag = new WPCF7_Shortcode( $tag );
if ( empty( $tag->name ) )
return '';
$args = array(
'size' => $tag->get_size_option( '40' ),
'maxlength' => $tag->get_maxlength_option(),
'class' => $tag->get_class_option( wpcf7_form_controls_class( $tag->type, $tag->name ) ),
'id' => $tag->get_option( 'id', 'id', true ),
'tabindex' => $tag->get_option( 'tabindex', 'int', true ),
'pre' => $tag->get_option( 'pre', '.*', true ),
'post' => $tag->get_option( 'post', '.*', true ),
);
$defaults = array(
'size' => '40',
'maxlength' => '40',
'class' => $tag->name,
'id' => $tag->name,
'tabindex' => 0,
'pre' => '<span class="wpcf7-form-control-wrap">',
'post' => '</span>',
);
wp_parse_args( $args, $defaults );
$value = '';
if ( wpcf7_is_posted() && isset($_POST[$tag->name]) )
$value = stripslashes_deep( $_POST[$tag->name] );
return sprintf(
$args['pre'] . '<input type="%2$s" name="%1$s" value="%3$s" />' . $args['post'],
$tag->name,
$tag->type,
esc_attr($value)
);
}

view raw
cf7_shortcode.php
hosted with ❤ by GitHub

バリデーションとかは入れてません

[WordPress] 特定のプラグインを強制的に有効にするプラグイン

wp-content/mu-plugins/ とかに入れておこう！

<?php
/*
Plugin Name: Just do it !
Plugin URI:
Description:
Version: 0.1
Author:
Author URI:
*/
new just_do_it();
class just_do_it {
private $must_plugins = array(
'WP Multibyte Patch' => 'wp-multibyte-patch/wp-multibyte-patch.php',
);
function __construct() {
add_action('shutdown', array($this, 'plugins_loaded'));
}
public function plugins_loaded() {
$activePlugins = get_option('active_plugins');
foreach ($this->must_plugins as $key => $plugin) {
if ( !array_search($plugin, $activePlugins) ) {
activate_plugin( $plugin, '', $this->is_multisite() );
}
}
}
private function is_multisite() {
return function_exists('is_multisite') && is_multisite();
}
}

view raw
just.php
hosted with ❤ by GitHub

[WordPress] meta box の位置を制御する

下北沢 OSS Cafe 確認スペシャルの補足
スケルトンだから、このままだと動かないよ。

<?php
new pan_pan_pan();

Class pan_pan_pan {
    private $field_name = array(
        'theme'   => 'pan_pan_pan_theme',
        'content' => 'pan_pan_pan_content',
    );
    CONST POST_TYPE  = 'pan_pan_pan';

    function __construct() {
        add_action( 'in_admin_header', array(&$this, 'in_admin_header') );
    }

    private function is_pan_pan_pan() {
        global $post_type;
        if ( isset($post_type) && $post_type === self::POST_TYPE )
            return TRUE;
        else if ( isset($_GET['post_type']) && $_GET['post_type'] === self::POST_TYPE )
            return TRUE;
        else
            return FALSE;
    }

    public function in_admin_header() {
        global $post_type, $current_user;

        if ( !$this->is_pan_pan_pan() )
            return;

        // 画面のカラム数の制御
        $screen_layout_columns = get_user_option("screen_layout_$post_type");
        if ( !$screen_layout_columns || $screen_layout_columns > 1 ) {
            update_user_option($current_user->ID, "screen_layout_$post_type", 1);
        }

        // メタボックスの表示位置の制御
        $meta_box_order_default = array(
            'side'     => '' ,
            'normal'   => "slugdiv,{$this->field_name['theme']},{$this->field_name['content']}",
            'advanced' => "submitdiv",
        );
        $meta_box_order = $meta_box_order_new = get_user_option("meta-box-order_$post_type");
        if ( $meta_box_order ) {
            // サイド
            $side = isset($meta_box_order['side'])
                ? explode(',', $meta_box_order['side'])
                : array();
            $meta_box_order_new['side'] = '';

            // ノーマル
            $normal = array_merge(
                explode(',', isset($meta_box_order['normal']) ? $meta_box_order['normal'] : $meta_box_order_default['normal']) ,
                $side
            );
            if ( !in_array($this->field_name['theme'], $normal) )
                $normal[] = $this->field_name['theme'];
            if ( !in_array($this->field_name['content'], $normal) )
                $normal[] = $this->field_name['content'];
            $meta_box_order_new['normal'] = implode(',', $normal);

            // advanced (サブミットボックスとか置いてある)
            $advanced = explode(',', isset($meta_box_order['advanced'])
                ? $meta_box_order['advanced']
                : $meta_box_order_default['advanced']);
            if ( !in_array('submitdiv', $advanced) )
                $advanced[] = 'submitdiv';
            $meta_box_order_new['advanced'] = implode(',', $advanced);
        } else {
            $meta_box_order_new = $meta_box_order_default;
        }
        if ( $meta_box_order !== $meta_box_order_new )
            update_user_option($current_user->ID, "meta-box-order_$post_type", $meta_box_order_new);

        // 隠したいメタボックスの制御
        $metaboxhidden = $metaboxhidden_new = (array)get_user_option("metaboxhidden_$post_type");
        if ( $metaboxhidden ) {
            if ( !in_array('categorydiv', $metaboxhidden) )
                $metaboxhidden_new[] = 'categorydiv';
            if ( !in_array('slugdiv', $metaboxhidden) )
                $metaboxhidden_new[] = 'slugdiv';
            if ( !in_array('commentstatusdiv', $metaboxhidden) )
                $metaboxhidden_new[] = 'commentstatusdiv';
        } else {
            $metaboxhidden_new = array('categorydiv','slugdiv','commentstatusdiv');
        }
        if ( $metaboxhidden !== $metaboxhidden_new )
            update_user_option($current_user->ID, "metaboxhidden_$post_type", $metaboxhidden_new);

        // 画面のカラム数の最大値を指定
        add_screen_option('layout_columns', array('max' => 1) );
    }
}

Hello Wapuu

「Hello Wapuu」プラグインは、「サイトの更新を応援するツール」を目指しています。

つまり、サイトを更新する応援キャラクターとして、「わぷー（Wapuu）」が登場して、サイトの更新を応援する、というような、運営者のモチベーションアップに繋がるプラグインを目指しています。

via. 「Hello Wapuu」というWordPress日本キャラクター「わぷー」を使ったプラグインを作りました。 | WordPress（ワードプレス）コミュニティ

このプラグイン中の最終更新日を取得するコード

function get_last_update(){
  global $wpdb;
  $date = $wpdb->get_results(
  ("
    SELECT MAX(post_date) as last
    FROM $wpdb->posts
    WHERE post_status = 'publish'
  ");
  return $date[0]->last;
}

惜しい、非常に惜しい。これだとマルチユーザに対応できない。
僕なら、こう書く。

function get_last_update(){
  global $wpdb;
  $current_user = wp_get_current_user();
  $date = $wpdb->get_results(
    $wpdb->prepare("
      SELECT MAX(post_date) as last
      FROM $wpdb->posts
      WHERE post_status = 'publish'
      AND post_author = %d
    ", (int)$current_user->ID
    )
  );
  return $date[0]->last;
}

あと get_last_update() って関数名は、他のプラグインでも使われそうな関数名なので、変えた方が良いですね。

[WordPress] XMLRPC を拡張する

XMLRPC を拡張するプラグインの作り方、あとでメインブログに清書します。

プラグイン本体

<?php
/*
Plugin Name: Ex XMLRPC
Version: 0.0.1
Plugin URI: 
Description: 
Author: wokamoto
Author URI: http://dogmap.jp/
*/
function wpex_xmlrpc_server($class_name) {
	if (!class_exists('wpex_xmlrpc_server'))
		require_once 'class-wpex-xmlrpc-server.php';
	return 'wpex_xmlrpc_server';
}
add_filter('wp_xmlrpc_server_class', 'wpex_xmlrpc_server');
?>

class-wpex-xmlrpc-server.php

<?php
class wpex_xmlrpc_server extends wp_xmlrpc_server {
	function __construct() {
		parent::__construct();
		$this->methods['wpex.getWpVersion'] = 'this:wp_getVersions';
	}

	public function wp_getVersions( $args ) {
		global $wp_version, $wpdb;

		if ( count((array) $args) > 2 ) {
			$this->escape( $args );
			$blog_id = (int) $args[0];
			$username = $args[1];
			$password = $args[2];
		} else {
			return $this->error;
		}

		if ( !$user = $this->login($username, $password) )
			return array(
				'wp' => $wp_version ,
				'php' => PHP_VERSION ,
				'mysql' => $wpdb->db_version() ,
				);
		} else {
			return $this->error;
		}
	}
}

確認方法

<?php
require_once("XML/RPC.php");

$host = "example.com";
$xmlrpc_path = "/xmlrpc.php";
$appkey = '';
$user = 'username';
$passwd ='yourpassword';

$c = new XML_RPC_client($xmlrpc_path, $host, 80);
$appkey = new XML_RPC_Value($appkey, 'string');
$username = new XML_RPC_Value( $user, 'string' );
$passwd = new XML_RPC_Value( $passwd, 'string' );

// blog ID の取得
$message = new XML_RPC_Message(
	'blogger.getUsersBlogs',
	array($appkey, $username, $passwd)
	);
$result = $c->send($message);
if( !$result )
	exit('Could not connect to the server.');
else if( $result->faultCode() )
	exit($result->faultString());
$blogs = XML_RPC_decode($result->value());
$blog_id = new XML_RPC_Value($blogs[0]["blogid"], "string");

// 拡張された XMLRPC メソッド wpex.getWpVersion の取得
$message = new XML_RPC_Message(
	'wpex.getWpVersion',
	array($blog_id, $username, $passwd)
	);
$result = $c->send($message);
if( !$result )
	exit('Could not connect to the server.');
else if( $result->faultCode() )
	exit($result->faultString());
var_dump(XML_RPC_decode($result->value()));
?>

実行結果

array(3) {
  ["wp"]=>
  string(5) "3.2.1"
  ["php"]=>
  string(5) "5.3.6"
  ["mysql"]=>
  string(6) "5.5.14"
}

追記:
こんな面倒なことしなくても xmlrpc_methods ってフィルタに引っ掛ければ良いだけだった…orz
WordPressにおけるXMLRPCの開発・・メソッドの増やし方とか – それ図解で。・・・tohokuaikiのチラシの裏