投稿者: ぜろみや

WordPressのプラグイン「Advanced Custom Fields」で、チェックボックス（セレクトボックス）の値を、選択してないやつも含めて全部取得したい。

例えば、「月火水木金土日」という選択肢があって、「火水」しか選択してなくても、とりあえずリストとして全部表示させたいわけである。

これはけっこう長いこと悩んでいて、あれこれややこしい方法で実装してみては「ほんまにこれしかないんか…」と調査しまくっていたが、ついにめっちゃ簡単な方法を見つけたので備忘録。

実装

関数”get_field_object()”を使う。

例えば、”custom_week”というカスタムフィールドに、「月～日」の選択肢を用意しており、更に土日を選択しているとき、値は以下のようになる。

$week = get_field_object('custom_week');
echo '<pre>';
var_dump($week);
echo '</pre>';

// 以下、出力部分
array(15) {
  ["key"]=>
  string(19) "field_59b111613d05f"
  ["label"]=>
  string(9) "営業日"
  ["name"]=>
  string(14) "custom_week"
  ["_name"]=>
  string(14) "custom_week"
  ["type"]=>
  string(8) "checkbox"
  ["order_no"]=>
  int(1)
  ["instructions"]=>
  string(0) ""
  ["required"]=>
  int(0)
  ["id"]=>
  string(24) "acf-field-custom_week"
  ["class"]=>
  string(8) "checkbox"
  ["conditional_logic"]=>
  array(3) {
    ["status"]=>
    int(0)
    ["allorany"]=>
    string(3) "all"
    ["rules"]=>
    int(0)
  }
  ["choices"]=>
  array(7) {
    ["月"]=>
    string(3) "月"
    ["火"]=>
    string(3) "火"
    ["水"]=>
    string(3) "水"
    ["木"]=>
    string(3) "木"
    ["金"]=>
    string(3) "金"
    ["土"]=>
    string(3) "土"
    ["日"]=>
    string(3) "日"
  }
  ["default_value"]=>
  string(0) ""
  ["layout"]=>
  string(10) "horizontal"
  ["value"]=>
  array(2) {
    [0]=>
    string(3) "土"
    [1]=>
    string(3) "日"
  }
}

“var_dump()”でデバッグしてしまえばだいたいわかるけど、この場合

“$week[‘choices’]”

で選択肢を配列で全部取得できる。あとはforeachで回すなりなんなり好きにしちゃいましょう！

繰り返しフィールドだろうとなんだろうと、get_field_object()で全値をとって、var_dump()で中身を見てしまえばなんだってできるね。

以上、現場からでした。

WordPressには関数やフック機能など、便利なものが一通り揃えられていますが、我々はそのほんの一部しか知りません。多すぎて覚えられるわけないし。なので、毎回「どうすんだっけなー」と探しちゃいますよね。

WordPressには、WordPressの全てが記されているであろう「WordPress Codex」というWikiが存在するんですが、初心者のうちはあんまり見ないですよね。なんか、ググって出てきたコードをコピペする感じ。

初心者のうちはそれでいいと思いますが、ある程度関数とかわかって自分でコードを書けるようになったらこれほどありがたいサイトはないので、ぜひ見てみてくださいね。今回は、その中でも開発に便利なページを紹介しますので、ブックマークしておきましょう。

関数リファレンス

→ リンク

WordPressの関数が全部あります。ここだけでもブックマークしておけばとりあえずＯＫ。

条件分岐タグ

→ リンク

よく使う条件分岐タグ。ほぼどんなものでも条件分岐できちゃう。ログインしてるときだけとか、便利ですよね。

テンプレートタグ

→ リンク

これ一つでいろんなテンプレートが呼び出せちゃうタグたち。

管理メニューの追加

→ リンク

管理画面のメニューに項目を追加するための関数たち。テーマ開発やプラグイン開発には必須ですね。

プラグイン API/フック

→ リンク

涙が出るほど便利だけど、鼻血が出るほどややこしい、フックについての基本が書かれています。特に「いつ関数を実行するのか」を指定するためのフックは開発でよく使いますね。

ただ、使い方についてはCodexの説明は正直よくわからないので、ググったほうがいいです。僕もそのうち書く…かも。

コーディング規約

→ リンク

WordPress開発するときのコーディング規約について書かれています。

「コーディング規約？何それ？」となってる方はぜひ見てみてください。あなたのコード、たぶん相当汚いです。

WordPressのコーディング規約は別に守らなくても誰からも怒られませんが、規約をなるべく守るよう心掛けるだけでも、綺麗で統一されたコードが書けるようになりますよ。なんか、WordPressしてるわーって気分になります。

おわり

以上、ブックマークしておくと捗りそうなページを紹介しました。最初はたぶん、見ても何書いてるかわからないと思うんですが、わかるようになればすごく楽しいです。特に、PHPの基礎がわかったら読めるようになると思いますよ。

PHP初心者にまず読んでほしい一冊の本

とりあえずざっと見て「こんなんあるんかー」くらいに認識しておいて、いざ開発で詰まったとき、「そういえば…」って思い出せたらいい感じ。

ではでは、良いWordPressライフを！

管理画面のメニューとか「設定」内に項目を追加する方法はググればすぐ見つかったんだけど、「ツール」内に項目を追加する方法がすぐには見つからなかったのでメモ。

使うのはadd_management_page()という関数でした。

使い方

使い方は以下の通り

add_management_page( 'Custom Permalinks', 'Custom Permalinks', 'manage_options', 'my-unique-identifier', 'custom_permalinks_options_page' );

使用例：

function all_update() {
  add_management_page('一括更新', '一括更新', 8, 'all_update', 'all_update_page');
}
add_action('admin_menu', 'all_update');

function all_update_page() {
  // HTML を表示させるコード
  ?>
  <div class="wrap">
    <h2>一括更新</h2>
    <p>ここにHTMLを書いていくよ</p>
  </div>
<?php
}

プラグインをインストールするとなんでもかんでも「設定」に入りがちだけど、ツールっぽい機能はやっぱりツールにいれたいよね。ということで探してみました。

add_management_page()でツール内に項目を追加する以外にも、「ユーザー」とか「ダッシュボード」とかにも追加できる関数をまとめて紹介しているCodexがありました。これをブックマークしておくと、プラグイン開発が捗りそうですね！

現場からは以上です。

クラ「WordPressのfeedをカスタマイズしてほしいです。しかもカスタム投稿ごとに内容を変えて。」

ぼく「できらぁ！！」

というわけでやってみました。案外簡単でした。

デフォルトのfeedを無効にする

まず、ややこしいのでWordPressデフォルトのfeedを無効にしておきましょう。functions.phpに以下記述

remove_filter('do_feed_rdf', 'do_feed_rdf', 10);
remove_filter('do_feed_rss', 'do_feed_rss', 10);
remove_filter('do_feed_rss2', 'do_feed_rss2', 10);
remove_filter('do_feed_atom', 'do_feed_atom', 10);

feedのテンプレートをコピー

自分でfeedのphpを書くのは非常にめんどうなので、WordPress本体のものをコピーして使っちゃいましょう。ちなみに、今回コメントのfeedは無視することにします。

“wp-includes”の中に以下４つのfeed用テンプレートがあるので、コピーしてテーマの中に持ってきます。

• feed-atom.php
• feed-rdf.php
• feed-rss
• feed-rss2.php

僕は、テーマの中に”feed”というディレクトリを作り格納しました。

新テンプレートを読み込むようにする

上でテーマ内に持ってきたfeedテンプレートを、WordPressのfeedとして使うようにします。functions.phpに以下記述

function custom_feed_rdf() {
  $template_file = '/feed/feed-rdf.php';
  $template_file = ( file_exists( get_stylesheet_directory() . $template_file )
      ? get_stylesheet_directory()
      : ABSPATH . WPINC
      ) . $template_file;
  load_template( $template_file );
}
add_action('do_feed_rdf', 'custom_feed_rdf', 10, 1);

function custom_feed_rss() {
  $template_file = '/feed/feed-rss.php';
  $template_file = ( file_exists( get_stylesheet_directory() . $template_file )
      ? get_stylesheet_directory()
      : ABSPATH . WPINC
      ) . $template_file;
  load_template( $template_file );
}
add_action('do_feed_rss', 'custom_feed_rss', 10, 1);

function custom_feed_rss2( $for_comments ) {
  $template_file = '/feed/feed-rss2' . ( $for_comments ? '-comments' : '' ) . '.php';
  $template_file = ( file_exists( get_stylesheet_directory() . $template_file )
      ? get_stylesheet_directory()
      : ABSPATH . WPINC
      ) . $template_file;
  load_template( $template_file );
}
add_action('do_feed_rss2', 'custom_feed_rss2', 10, 1);

function custom_feed_atom( $for_comments ) {
  $template_file = '/feed/feed-atom' . ( $for_comments ? '-comments' : '' ) . '.php';
  $template_file = ( file_exists( get_stylesheet_directory() . $template_file )
      ? get_stylesheet_directory()
      : ABSPATH . WPINC
      ) . $template_file;
  load_template( $template_file );
}
add_action('do_feed_atom', 'custom_feed_atom', 10, 1);

do_feed_atom()あたりをWordPress Codexでさらっと見ておくとわかりやすいです。

feedテンプレートをカスタマイズ

これでようやくカスタマイズの準備が整いました。さっそくカスタマイズ…する前に、もうちょっと事前知識を入れておきましょう。

投稿タイプごとにfeedを表示させるには？

例えば、通常の投稿のfeedであれば、”http://hogehoge.com/feed/”というように、ホームURLの末尾に”/feed/”をつければ表示されます。

では、カスタム投稿”shop”の場合はどうかというと、

というように、”?post_type=[カスタム投稿名]”をパラメータとしてつけることで表示できます。

ということはすなわち、テンプレートに”post_type”というパラメータが渡っていて、それが変数として使われていると推測されます。

そしてWordPressさんのことだから、変数名はきっと”$post_type”だろうと思ってやってみたところ、ドンピシャでした。よかったー、ここわかんなかったらけっこう苦労してたかも。

というわけでカスタマイズ開始

一番簡単な”feed-rss.php”を例にします。デフォルトまんまで開くとこんな感じ

<?php
/**
 * RSS 0.92 Feed Template for displaying RSS 0.92 Posts feed.
 *
 * @package WordPress
 */

header('Content-Type: ' . feed_content_type('rss') . '; charset=' . get_option('blog_charset'), true);
$more = 1;

echo '<?xml version="1.0" encoding="'.get_option('blog_charset').'"?'.'>'; ?>
<rss version="0.92">
<channel>
	<title><?php wp_title_rss(); ?></title>
	<link><?php bloginfo_rss('url') ?></link>
	<description><?php bloginfo_rss('description') ?></description>
	<lastBuildDate><?php
		$date = get_lastpostmodified( 'GMT' );
		echo $date ? mysql2date( 'D, d M Y H:i:s +0000', $date ) : date( 'D, d M Y H:i:s +0000' );
	?></lastBuildDate>
	<docs>http://backend.userland.com/rss092</docs>
	<language><?php bloginfo_rss( 'language' ); ?></language>

	<?php
	/**
	 * Fires at the end of the RSS Feed Header.
	 *
	 * @since 2.0.0
	 */
	do_action( 'rss_head' );
	?>

<?php while (have_posts()) : the_post(); ?>
	<item>
		<title><?php the_title_rss() ?></title>
		<description><![CDATA[<?php the_excerpt_rss() ?>]]></description>
		<link><?php the_permalink_rss() ?></link>
		<?php
		/**
		 * Fires at the end of each RSS feed item.
		 *
		 * @since 2.0.0
		 */
		do_action( 'rss_item' );
		?>
	</item>
<?php endwhile; ?>
</channel>
</rss>

なんのことはない、普段よく触るテンプレートとだいたい一緒です。

実際にfeedをブラウザを表示させ、どの関数が何を出力しているのか見ながらやればけっこう簡単に理解できます。

そして、33行目を見てください。そう、これ…あれですよね！普通に記事をループさせてるだけです！

記事をループしているので、いつも通り$postとかも使えちゃいます。

なので、カスタムフィールドもあっさり取得できます。以下は例えばAdvanced Custom Fieldsで取得できる値。

“$post”さえあればいろんな値が取得できます。

で、カスタム投稿タイプは？

肝心のそこですが、例えば

で開かれたfeedには、$post_type という変数に”shop”が格納されています。ありがたいですね。

じゃああとは、$post_typeに入っている値によって場合分けしてやればOKです。

<?php
/**
 * RSS 0.92 Feed Template for displaying RSS 0.92 Posts feed.
 *
 * @package WordPress
 */

header('Content-Type: ' . feed_content_type('rss') . '; charset=' . get_option('blog_charset'), true);
$more = 1;

echo '<?xml version="1.0" encoding="'.get_option('blog_charset').'"?'.'>'; ?>
<rss version="0.92">
<channel>
	<title><?php wp_title_rss(); ?></title>
	<link><?php bloginfo_rss('url') ?></link>
	<description><?php bloginfo_rss('description') ?></description>
	<lastBuildDate><?php
		$date = get_lastpostmodified( 'GMT' );
		echo $date ? mysql2date( 'D, d M Y H:i:s +0000', $date ) : date( 'D, d M Y H:i:s +0000' );
	?></lastBuildDate>
	<docs>http://backend.userland.com/rss092</docs>
	<language><?php bloginfo_rss( 'language' ); ?></language>

	<?php
	/**
	 * Fires at the end of the RSS Feed Header.
	 *
	 * @since 2.0.0
	 */
	do_action( 'rss_head' );
	?>
<?php if( $post_type == 'shop' ): ?>
<?php while (have_posts()) : the_post(); ?>
<?php $thumb = get_field('acf_thumb', $post->ID ); ?>
	<item>
		<title><?php the_title_rss() ?></title>
		<?php if( $post->post_content ): ?>
		<description><![CDATA[<?php the_excerpt_rss() ?>]]></description>
<?php endif; ?>
<?php if($thumb): ?>
		<link><?php the_permalink_rss() ?></link>
<?php else: ?>
<link><?php echo home_url('/'); ?></link>
<?php endif; ?>
		<?php
		/**
		 * Fires at the end of each RSS feed item.
		 *
		 * @since 2.0.0
		 */
		do_action( 'rss_item' );
		?>
	</item>
<?php endwhile; ?>
<?php else: ?>
<?php while (have_posts()) : the_post(); ?>
<?php $link = get_field('acf_link', $post->ID ); ?>
	<item>
		<title><?php the_title_rss() ?></title>
		<?php if( $link ): ?>
		<link><?php $link; ?></link>
<?php else: ?>
<link><?php echo home_url('/') ?></link>
<?php endif; ?>
		<?php
		/**
		 * Fires at the end of each RSS feed item.
		 *
		 * @since 2.0.0
		 */
		do_action( 'rss_item' );
		?>
	</item>
<?php endwhile; ?>
<?php endif; ?>
</channel>
</rss>

これでよし。

以上、現場からでした。

「このカスタムフィールドに値がある記事だけで『前の記事へ』『次の記事へ』のページ送りを実装してください」と言われたけど、思ったより大変だったのでメモ。

通常、詳細記事のページネーションは”previous_post_link()”と”next_post_link()”を使えば簡単に実装できるんだけど、この関数は残念ながらカスタムフィールドの有無の判定とかはできないので、がんばってphpを書いたのであった。

functions.phpに以下を記述

function get_custom_pagenation() {
  global $post;
  $html = '';
  $current_id = $post->ID; //現在の記事のID
  $array_has_thumb = array();

  // カスタムフィールドに値がある記事を全部出して、"$array_has_thumb"にIDを格納
  $wp_query = new WP_Query();
  $param = array(
    'posts_per_page' => '-1',
    'post_type' => 'post',
    'meta_key' => 'hoge',
    'meta_value' => false,
    'meta_compare' => '!='
  );
  $wp_query -> query( $param );

  if( $wp_query -> have_posts() ){
    while( $wp_query -> have_posts() ) {
      $wp_query -> the_post();
      $array_has_thumb[] = $post->ID;
    }
  }
  wp_reset_query();

  // "$array_has_thumb"から現在の記事IDのキーを取り出しておく
  $current_key = array_keys( $array_has_thumb, $current_id );

  // 前の記事のID
  foreach( $array_has_thumb as $data ) {
    if( $data == $current_id ) {
      break;
    }
    $prev_id = $data;
  }
  // 次の記事のID
  foreach( $array_has_thumb as $key => $value ) {
    $next_id = $value;

    if( $key > $current_key[0] ) {
      break;
    }
  }
  if( $next_id == $data ) {
    $next_id = NULL;
  }

  // IDが取得出来たらその記事のパーマリンクを取得
  if ( $prev_id ) {
    $prev_link = get_permalink( $prev_id );
  }
  if ( $next_id ) {
    $next_link = get_permalink( $next_id );
  }

  // 出力部分
  if( $prev_link ) {
    $html .= '<p class="prev"><a href="' .$prev_link. '">前の記事へ</a></p>';
  }
  $html .= '<p class="list"><a href="' .home_url('/'). '">トップへ</a></p>';
  if ( $next_link ) {
    $html .= '<p class="next"><a href="' .$next_link. '">次の記事へ</a></p>';
  }
  return $html;
}

だいたいコメントに書いてある通りの処理です。

要は、

• まず’hoge’というカスタムフィールドに値がある記事のみループさせ、
• 配列’$array_has_thumb’に記事IDを格納。
• その配列から、今の記事IDの前後の記事IDを取得して、
• 記事IDが取得できていたらページネーションを表示

という流れです。前後の記事IDを取得する部分はもうちょい綺麗に書けそう…あとは、meta_keyやpost_typeの値を引数で渡してやると汎用性高まりますね。まぁそれは気が向いたら挑戦してみてください。🤗

使うときはテンプレートに

<?php echo get_custom_pagenation(); ?>

と書くと表示されます。

現場からは以上です。

WordPressの投稿画面でカテゴリーを選択するとき、子カテゴリーを持つ親カテゴリーは選択できないようにする。

調べたら何件か情報があったけど、どれも若干古くて動かなかったりしたのでWP最新版＋php7でも動くように修正しました。

functions.phpに以下を記述（コピペでＯＫ）

<?php
require_once(ABSPATH . '/wp-admin/includes/template.php');
class Nocheck_Category_Checklist extends Walker_Category_Checklist {

  function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
    extract($args);
    if ( empty( $taxonomy ) )
      $taxonomy = 'category';

    if ( $taxonomy == 'category' )
      $name = 'post_category';
    else
      $name = 'tax_input['.$taxonomy.']';

    $class = in_array( $category->term_id, $popular_cats ) ? ' class="popular-category"' : '';
    $cat_child = get_term_children( $category->term_id, $taxonomy );

    if( !empty( $cat_child ) ) {
      $output .= "\n<li id='{$taxonomy}-{$category->term_id}'$class>" . '<label class="selectit"><input value="' . $category->term_id . '" type="checkbox" name="'.$name.'[]" id="in-'.$taxonomy.'-' . $category->term_id . '"' . checked( in_array( $category->term_id, $selected_cats ), true, false ) . disabled( empty( $args['disabled'] ), true, false ) . ' /> ' . esc_html( apply_filters('the_category', $category->name )) . '</label>';
    } else {
      $output .= "\n<li id='{$taxonomy}-{$category->term_id}'$class>" . '<label class="selectit"><input value="' . $category->term_id . '" type="checkbox" name="'.$name.'[]" id="in-'.$taxonomy.'-' . $category->term_id . '"' . checked( in_array( $category->term_id, $selected_cats ), true, false ) . disabled( empty( $args['disabled'] ), false, false ) . ' /> ' . esc_html( apply_filters('the_category', $category->name )) . '</label>';
    }
  }

}

function wp_category_terms_checklist_no_top( $args, $post_id = null ) {
  $args['checked_ontop'] = false;
  $args['walker'] = new Nocheck_Category_Checklist();
  return $args;
}
add_action( 'wp_terms_checklist_args', 'wp_category_terms_checklist_no_top' );

これでよし。

古いコードで動かなかった原因は、phpのバージョンによる”extends”の仕様変更（引数のデフォルト値が同じじゃないとだめ）と、WPのバージョンに伴い”get_category_children()”という関数が使えなくなっていたからでした。

このコードも今は動いていますが、そのうち動かなくなる日が来るかもですね！

現場からは以上です。

いちばんやさしいWordPressの教本第3版 人気講師が教える本格Webサイトの作り方 (「いちばんやさしい教本」)

Amazonで見る

WordPressでは、テンプレートファイルに以下のように書くことで、他のphpファイルを読み込むことができる。

例えばテーマ内の”hoge.php”というファイルを読み込みたかったら、

get_template_part('hoge');

と書けばOK。しかしこれはphpなので、投稿とかでは使えません。固定ページの途中でループを使いたいんじゃ…といったことがたまにあると思います。

そこで今回はこれを、投稿内やウィジェットでも読み込めるようにします。

基本的に、投稿やテキストウィジェット内でphpを使えるようになるプラグイン”PHP Execution”はセキュリティ上使わないほうがいいので、ショートコードを使って読み込むことにする。

functions.phpに以下を記述。

<?php
// テンプレート呼び出し用ショートコード
function my_php_Include( $params = array() ) {
  extract( shortcode_atts(array('file' => 'default'), $params ) );
  ob_start();
  get_template_part( $file );
  return ob_get_clean();
 }
 add_shortcode('myphp','my_php_Include');

これで、投稿内で”hoge.php”を読み込みたい場合は

[myphp file='hoge']

とショートコードを書けばＯＫ。

“hoge”の部分を変えれば他のファイルも読み込めます。

ウィジェットの「テキスト」でも使いたい場合は、ウィジェットでショートコードを使えるようになる以下のコードをfunctions.phpに追加する。

add_filter('widget_text', 'do_shortcode' ); //ウィジェットでショートコードを使う

これでテキストウィジェットでもショートコードが使えます。

現場からは以上です。

お問い合わせフォームとかで、フォームに日本語や全角テキストを入力すると、うまくPOSTできずに消えてしまう事案が発生。

原因は、phpの文字コード設定にありました。

php.iniの設定を見る

既にphp.iniがサーバーによって用意されている場合は、php.iniを確認してみましょう。

php.iniの場所がわからないときは

現在読み込まれているphp.iniは、phpinfo()によって確認できます。

info.php等適当なphpファイルを作り、以下のようにコードを書きます

<?php phpinfo(); ?>

書いたらファイルをFTPでサーバーにアップし、ファイルにアクセス。

すると、現在利用されているphpの情報が表示されます。これは使う機会が多いので覚えておきましょう

上の画像が、現在読み込まれているphp.iniです。

php.iniの場所がわかったら、FTPでphp.iniをダウンロードし、ファイルを開きます。

下記のような部分があったら修正しましょう

mbstring.internal_encoding = EUC-JP

↓

mbstring.internal_encoding = UTF-8

修正したらアップし、フォームの動作を確認してください。

別のphp.iniがある場合

あれれ？サーバーが用意したphp.ini以外にも、ルートディレクトリなんかにもphp.iniがあるぞ？

という場合が稀にあります。たぶん、WordPressを使うにあたってサーバーのデフォルトのphp.iniじゃ話にならないので、誰かが新たに自前のphp.iniを追加したんでしょうね。また、サーバーによってはもとからここに置いてある場合もあります。いろいろ大人の事情があるんでしょう。

まずはその別php.iniを開いて中身を読んでみて、’mbstring.internal_encoding = UTF-8‘という内容が書かれているにも関わらずエラーが出る場合、なんらかの理由でこのphp.iniが読み込まれていない可能性が高いです。

前章で説明したphp.iniの場所探しで、この別php.iniが読み込まれていない場合、.htaccessを見てみてください。

下記のような表記があるでしょうか？あるかもしれませんし、ないかもしれません

setenv PHPRC /home/xxx.com/html/

このコードは、別php.iniを読み込むためのコードです。

ない場合は追加しましょう。php.iniが置いてある場所を絶対パスで指定します。

ある場合は、内容が間違っていないか確認します。

絶対パスがわからないときは

適当なphpファイルに下記コードを書き、アップしてアクセス。

<?php echo __FILE__; ?>

WordPressを使っている場合は要注意

で、今回なんでこんなエラーが出たかというと、WordPressでパーマリンクを変更した際に.htaccessが上書きされ、php.ini読み込み部分のコードが消えてしまったのが原因です。

なかなかホラーですよね…

何かサイト全体、もしくはフォームに影響がありそうな変更があった場合はフォームの動作確認を必ずしましょう。特にコンバージョンに関わる部分にエラーが出るとやばいですからね。。

がんばれWordPressマン！