カテゴリー別アーカイブ: WordPress

WordPressでよく見かけるけどよくわからない関数 esc_urlについて

esc_urlについて

先日とある勉強会で
「WordPressの配布されてるテーマでは結構使われているようなんですけれど、esc_urlという関数って何のためにあるのですか?」
という質問を頂きました。
「エ、エスケープする関数なんで適当に使ったらいいですよ!」
なんていう答えにならない答えを返してしまったので反省して調べておきます。

WordPressに標準で付いてくるデフォルトテーマにはesc_urlがふんだんに使われています。
たとえばtwenty fifteenではheader.phpに使われていて

<?php echo esc_url( get_template_directory_uri() );

といったように、テンプレートディレクトリを出力する際に間に挟んで利用しています。

どうしてこのように出力をするためにつかっているのか、なぜそのまま出力するといけないのかについて調べてみました。

マニュアルを調べてみた

まずは公式の説明について調べてみました。
幸い日本語訳がありましたのでそちらを紹介します。

テキストや属性などのURLを無害化する時に用いる関数です。ホワイトリストに登録されているプロトコル (デフォルトでは、http, https, ftp, ftps, mailto, news, irc, gopher, nntp, feed, telnet) 以外のURLを拒絶し、無効なキャラクタを除外し、危険なキャラクタを削除します。 この関数はキャラクタをHTMLエンティティとしてエンコードし、 (X)HTML または XML ドキュメントを作成する時に用います。アンド記号 (&) とシングルクォート (') はそれぞれ (&#038, &#039) という形に変換します。 この関数は非推奨となった clean_url() の代わりに用いるものです。

なるほど、ホワイトリストに登録されているプロトコル以外を拒否し、また使ってはダメな文字をURLから省いたり変換したりするもの、なのですね。

実際に動かしてみる

それでは早速どのような動きになるか試してみました。

$urls = array(
  'http://www.example.com/hogehoge',
  'https://www.example.com/hogehoge',
  'tel://example.com',
  'tel://0120000000',
  'http://.$,;:&=?!*~@#_()',
  'http://\"\'|*`^><)(}{][',
);
foreach($urls as $url) {
  echo $url."<br />\n";
  echo esc_url($url)."<br />";
}

出力はこうなります

元テキスト esc_url変換後
http://www.example.com/hogehoge http://www.example.com/hogehoge
www.example.com/hogehoge http://www.example.com/hogehoge
https://www.example.com/hogehoge https://www.example.com/hogehoge
tel://example.com tel://example.com
tel://0120000000 tel://0120000000
hoge://0120000000
http://.$,;:&=?!*~@#_()’| http://.$,;:&=?!*~@#_()’|
http://\”`^><{}[] http://
http://ほげふがぴよ http://ほげふがぴよ

なるほど、色々と変化していますね。
httpやhttpsはそのまま出力されていますね。
またtel:も出力されているようです。マニュアルにtelというのは無いのですが、どうやら出力されるようです。
ログなどを追いかけてみると(#18268, #21081, src)WordPress3.4あたりで「telやfaxといったプロトコルも追加してくれ」という要望があがったそうで、それに対応する形で追加れたようです。
他には記号系が削除されるようですね。これはURLで利用してもよい文字とそうでは無い文字がありまして、そのルールに沿って削除されるようです。

esc_urlの目的

さて、このesc_urlの目的なのですがなぜ必要なのかについて考えてみました。
まずはURLとして無効な文字を防ぐことですね。
URLに利用して良い文字というのはIETFがRFC1738として定義しています。一般の利用者が「この文字は使える、これはダメ」と調べるのは大変ですから、esc_urlを利用する事でこの違反を防ぐことができます。
またプロトコルのホワイトリストについては、インジェクション攻撃などに対応する目的があるでしょう。例えばコメントの「ウェブサイト」の部分にtelで110番を書かれてしまうと、携帯電話ユーザがクリックした際、いきなり110番が掛かってしまったりします。今ではウェブサイトやメールから通話する際には警告がでますが、そういった対処の無かったガラケー全盛期に流行った手法ですね。
telプロトコルの許可については許可されていると書きましたが、調べたところコメントでは不許可のようです。
プロトコルのホワイトリストについてはテーマ作成者がちゃんと管理できるようになっているので、例えばお店紹介サイトであれば「どこでもtelプロトコルを許可したい」、といった要望にも応えることができます。
基本的にesc_urlの目的としては、「意図しないURLの誤った誘導を防ぐ」ことだと思っています。ですのでテーマを作成する際にURLを出力する箇所でesc_urlを埋め込むことで不正なURLが吐き出されることを防いでくれます。

まとめ

esc_urlを使うと不正なURLを防いでくれます。またコメント(本文ではないところ)などURLが入ってくる箇所でesc_urlを挟む事でインジェクション攻撃を防ぐことにもなります。
ですのでURLが入る箇所では積極的にesc_urlを使っていきたいですね。

[email protected] 14.04 LTS

少し流行は過ぎてしまったのですが、UbuntuのnginxでWordPressを動かしたのでメモ。

1. 構成
まずは構成について。
ウェブサーバの構成について、単にnginxを使うとしてもいろいろな構成があるんだけれど、今回はリバースプロキシを使った構成にしました。

リバースプロキシはユーザからのリクエストを受ける際、いったんプロキシサーバがリクエストを受け取って、それを本当のウェブサーバに問い合わせを行う、というそんな機能を提供してくれます。
プロキシ(代理)サーバなので、リクエストを途中から代理してくれる、そんなサーバです。
リバースと付いているのは、リバースじゃ無い普通のプロキシサーバもありまして、こちらはクライアント側で利用します。リバースプロキシはリバース、逆向きなので、サーバ側において代理させるんですね。
ちなみにリバースプロキシサーバ、プロキシサーバともにキャッシュ機能が付いている物がほとんどです。

で、今回の構成では、インターネット側からのリクエストをnginxのリバースプロキシで受けて、それを内部のnginxへリクエスト、そのnginxはWordPressに必要なPHPをPHP-FPMというものを使って動作する、ということに。
このリバースプロキシを使うことでキャッシングが容易にできるのでWordPressの高速化が進む、というものですね。

ちなみにPHP-FPMはプロセスで待ち受けさせていて、リクエストがあるとすぐにPHPを実行して結果を返すという、そういう仕組みをもったPHPのサーバ、デーモンです。

一台のサーバで”リバースプロキシ”、”ウェブサーバ”、”PHPサーバ(アプリケーションサーバ)”を動かす必要があるので、そのやりとりにはいくつかのルールが必要です。
サーバへリクエストを投げるときには必ず、どのサービスへ繋ぐか、という情報が必要なのですが、これを通常ポート番号によって振り分けるのです。
ちなみに一般的なウェブサービスだと80番を利用します。またプロキシサーバでは8080版を利用します。

今回はリバースプロキシですのでこいつが80番で待ち受けて、このリバースプロキシからウェブサーバへはウェブサーバの8080番ポートへ接続、PHPが動いているデーモンへはポート番号じゃなくてsockという仕組みで繋ぐことにしました。

2. 手順
まずはインストール。ubuntuなのでaptを利用します。今回必要になるのはnginx, php-fpmです。

shell> sudo apt-install nginx php-fpm
shell> cd /etc/nginx

インストールが終わったらnginxのデフォルトコンフィグが格納されている/etc/nginxで作業します。

まずは早速、WordPressに必要なnginxのconfigを二つ書きます。
これはWordPressの公式サイトで紹介されています。二つのconfを/etc/nginx/siteconf.d/というディレクトリを作って配置しています。

more /etc/nginx/siteconf.d/global_restrictions.conf       
# this file is from http://codex.wordpress.org/Nginx                            # Global restrictions configuration file.                                       
# Designed to be included in any server {} block.</p>                           
location = /favicon.ico {                                                       
         log_not_found off;                                                     
         access_log off;
}

location = /robots.txt {
         allow all;
         log_not_found off;
         access_log off;
}

# Deny all attempts to access hidden files such as .htaccess, .htpasswd, .DS_Sto
re (Mac).
# Keep logging the requests to parse later (or to pass to firewall utilities suc
h as fail2ban)
location ~ /\. {
         deny all;
}






shell> cat /etc/nginx/siteconf.d/wordpress_base
# this file is from http://codex.wordpress.org/Nginx

# WordPress single blog rules.
# Designed to be included in any server {} block.

# This order might seem weird - this is attempted to match last if rules below fail.
# http://wiki.nginx.org/HttpCoreModule
location / {
         try_files $uri $uri/ /index.php?$args;
}

# Add trailing slash to */wp-admin requests.
rewrite /wp-admin$ $scheme://$host$uri/ permanent;

# Directives to send expires headers and turn off 404 error logging.
location ~* ^.+\.(ogg|ogv|svg|svgz|eot|otf|woff|mp4|ttf|rss|atom|jpg|jpeg|gif|png|ico|zip|tgz|gz|rar|bz2|doc|xls|exe|ppt|tar|mid|midi|wav|bmp|rtf)$ {
       access_log off; log_not_found off; expires max;
}

# Uncomment one of the lines below for the appropriate caching plugin (if used).
#include global/wordpress-wp-super-cache.conf;
#include global/wordpress-w3-total-cache.conf;

# Pass all .php files onto a php-fpm/php-fcgi server.
location ~ \.php$ {
         # Zero-day exploit defense.
         # http://forum.nginx.org/read.php?2,88845,page=3
         # Won't work properly (404 error) if the file is not stored on this server, which is entirely possible with php-fpm/php-fcgi.
         # Comment the 'try_files' line out if you set up php-fpm/php-fcgi on another machine.  And then cross your fingers that you won't get hacked.
         try_files $uri =404;

         fastcgi_split_path_info ^(.+\.php)(/.+)$;
         #NOTE: You should have "cgi.fix_pathinfo = 0;" in php.ini

         include fastcgi_params;
         fastcgi_index index.php;
         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
         fastcgi_param REMOTE_ADDR  $http_x_real_ip;
#        fastcgi_intercept_errors on;
         fastcgi_pass unix:/var/run/php5-fpm.sock;
}

最初のglobal_restrictions.confでは不正なアクセスを防ぐための設定です。nginxでは.htaccessを初めとしたファイルを利用しませんので、それらのファイルが標準では直接表示されたりします。中にはパスワードを書いてあったりすることもあるので安全のためこれらのファイルを非表示にするconfです。

続いてwordpress_base.confです。これがnginxとphp-fpmでwordpressを動かすための基本的なconfigになります。ほとんどは公式通りなのですが、注意点がいくつかあります。
conf本体の下部にある、 “fastcgi_param REMOTE_ADDR $http_x_real_ip;”については追記してあります。
これは今回リバースプロキシを使うに当たって、ウェブサーバで見えるクライアントIPアドレスが127.0.0.1のような自分自身のアドレスになってしまうことを防ぐ処置です。
自分自身をリバースプロキシにする場合に限らず何らかのリバースプロキシを挟むとREMOTE_ADDRが書き換わってしまいます。そうするとアクセス解析やコメントをつけた人のIPアドレスがすべて同じものになってしまい意味のないものになってしまいます。
それを防ぐための構文になります。ちなみにapacheであればmod_rpafというモジュールで対処したりします。
もう一点気をつける構文は”fastcgi_pass unix:/var/run/php5-fpm.sock;”です。今回はPHPとnginxを動かすサーバが同じサーバでしたのでsockを利用しました。他のホストで動かす場合やTCP/IPで動かす場合には変更が必要です。

これでwordppressの基本的なconfは揃いました。続いてはサイトのconfを書きます。

最近はnginxもapache同様、ドメインごとにconfigを書いてシンボリックリンクで有効化/無効化する流れになっています。今回は /etc/nginx/sites-available/example.com で作成しました。
このconfにはリバースプロキシ用の設定も含まれるので少し大変です。

shell> cat /etc/nginx/sites-available/exampel.com.conf
server {
        listen 80;
        server_name www.example.com;
        root        /home/yousan/public_html/www.example.com;
        index index.html index.htm index.php;
        include siteconf.d/global_restrictions.conf;

# ここから下がリバースプロキシ用の設定 最後にドメインの名前を設定すること
# またnginx.confのbackednともセットで設定すること
              location /wp-admin { proxy_pass http://backend; }
              location ~ .*\.php { proxy_pass http://backend; }
        location / {
              set $mobile "";
              if ($http_user_agent ~* '(DoCoMo|J-PHONE|Vodafone|MOT-|UP\.Browser|DDI
POCKET|ASTEL|PDXGW|Palmscape|Xiino|sharp pda browser|Windows CE|L-mode|WILLCOM|SoftB
ank|Semulator|Vemulator|J-EMULATOR|emobile|mixi-mobile-converter)') {
              set $mobile "@ktai";
              }
              if ($http_user_agent ~* '(iPhone|iPod|Opera Mini|Android.*Mobile|NetFr
ont|PSP|BlackBerry)') {
              set $mobile "@mobile";
              }
              if ($http_cookie ~* "comment_author_|wordpress_(?!test_cookie)|wp-post
pass_" ) {
              set $do_not_cache 1;
              }
              proxy_no_cache     $do_not_cache;
              proxy_cache_bypass $do_not_cache;
              proxy_cache czone;
              proxy_cache_key "$scheme://$host$request_uri$is_args$args$mobile";
              proxy_cache_valid  200 301 302 60m;
              proxy_cache_valid  404 5m;
              proxy_cache_use_stale  error timeout invalid_header updating http_500
http_502 http_503 http_504;
              proxy_pass http://backend;
              proxy_redirect http://www.example.com:8080/ /;
       }
}

server {
    listen      8080;
    server_name www.example.com;
    index index.html index.htm index.php;
    include siteconf.d/global_restrictions.conf;
    include siteconf.d/wordpress_base.conf;
    root            /home/yousan/public_html/www.examplecom.com;
}

shell> sudo ln -s /etc/nginx/sites-available/example.com.conf /etc/nginx/sites-enabled

このconfでは上のserverディレクティブで80番の待ち受け、リバースプロキシ側の待ち受けを設定します。この中で最後の方にあるproxy_redirectという構文で実際にPHP等が動いている8080で待ち受けをしているウェブサーバへ転送しています。
下の8080で待ち受けをしているところは先ほどwordpress用のconfを書きましたのでそれらをincludeして、あとは少し書いてやるだけでOKです。

ドメインごとのconfを書いたらlnでシンボリックリンクをsites-availableへ移してあげてください。こうすることで有効化されます。

最後にnginx本体のconfを書きます。
今回はリバースプロキシでレスポンスを早くしよう!というが目的ですのでリバースプロキシのキャッシュとgzip圧縮を有効化します。
ココでもリバースプロキシ用の設定を分けてあります。
機能別に分けられたconfはconf.dに入れると自動で読み込まれますのでそちらに入れておきます。自動に読まれますけれど*.confという名前じゃないとダメなので注意してください。

shell> cat /etc/nginx/conf.d/
proxy_cache_path  /var/cache/nginx levels=1:2 keys_zone=czone:4m max_size=50m inacti
ve=120m;
proxy_temp_path   /var/tmp/nginx;
proxy_cache_key   "$scheme://$host$request_uri";
proxy_set_header  Host               $host;
proxy_set_header  X-Real-IP          $remote_addr;
proxy_set_header  X-Forwarded-Host   $host;
proxy_set_header  X-Forwarded-Server $host;
proxy_set_header  X-Forwarded-For    $proxy_add_x_forwarded_for;
proxy_set_header  Remote-Addr        $remote_addr;
#real_ip_header X-Forwarded-For;
#real_ip_recursive on;

upstream backend {
             ip_hash;
             server 127.0.0.1:8080;
}

こちらが本体側のconfです。ほとんど書き換えてないのでコメントを外すだけですね。

shell> cat /etc/nginx/nginx.conf
... 省略 ...
       ##
        # Gzip Settings
        ##

        gzip on;
        gzip_disable "msie6";

        gzip_vary on;
        gzip_proxied any;
        gzip_comp_level 6;
        gzip_buffers 16 8k;
        gzip_http_version 1.1;
        gzip_types text/plain text/css application/json application/x-javascript tex
t/xml application/xml application/xml+rss text/javascript;

これでconfが整いました。
最後にnginxを再起動して動作確認です。

shell> sudo service nginx restart

さて、動いたでしょうか。

今回自分もすぐには動かず、いくつかはまった点がありましたので紹介しておきます。
1. 文末のセミコロン忘れ
2. www.example.comというドメインのまま、ドメイン名を書き換え忘れていた
nginxではほとんどの文末にセミコロンをつける習慣がありますので、これを忘れるとエラーになります。
ドメイン名の書き換えでは色んなサイトを参考にしながらconfを書いたのですが、confの途中にドメイン名がでていて、今回実際に運用するドメインに書き換えるのを忘れていて動きませんでした。

これらのエラーについてはerror.logを見る事でどのファイルのどこでエラーが起きている、ということが分かったりします。

shell> sudo tail /var/log/nginx/error.log

ただ中には直接的にエラーが表示されず、推測に推測を重ねてエラーを取り除く必要もありますがそちらについては…、経験が物をいいますね!

以上となります。

WordPressの検索で検索結果が表示されなくて困った

WordPressの検索をいじっている最中に検索結果が出なくて困った。

pre_get_posts (にフックした関数)をいじっていたんだけれど、全然思ったような結果にならずに結構困っていた。

原因は色々あったんだけれど、二箇所で困ったのでメモしておく。

検索結果がでない、ということはSQLに問題がある。

なのでSQLの中身を確認してなぜ出ないかを検討することに。

以下のダンプをpre_get_postではなく、利用したいテンプレート側に記載。

$wp_query->requestは実行されたSQL文なんだけど、これはpre_get_postsの後に実行されたSQL文なので該当するテンプレートに記載しないと読み出せない。


<span style="line-height: 1.5;">var_dump($wp_query->request);</span>

まず一つはpost_typeが’post’にしかなっていない点。これはpre_get_postsの関数内で


$query->set('post_type', 'post');

を記載すること。これが実は結構やっかいで、他の条件文、例えばtax_queryなどと組み合わす際には無くても何とかなったりするので、条件文を組み立てている最中のデバッグと完成したカタチではpost_typeの指定が必要か不要か、結構迷うことになる。

post_typeに何も指定されていない場合に実際に中身を決定づけているのはwp-includes/query.phpのget_posts内でpost_type = ‘any’として処理していき、状況に応じていろんなのが入る。例えばattachmentとかpostなど。

このget_postsは結構大きなメソッドでこれまた結構読みづらいんだけど、詰まるたんびに読んでいればそのうち読めるようになるかも。

さて次いで検索結果がでない状況に当たったんだけど、これはSQL内に 0 = 1 なんていう文が。例えば下記のような感じに。


string(250) "SELECT SQL_CALC_FOUND_ROWS wp_posts.ID FROM wp_posts WHERE 1=1 AND 0 = 1 AND wp_posts.post_type = 'custom_post' AND (wp_posts.post_status = 'publish' OR wp_posts.post_status = 'private') GROUP BY wp_posts.ID ORDER BY wp_posts.post_date DESC LIMIT 0, 5"

where句の二つ目にばっちり0 = 1の条件が。おかげさまで検索結果はゼロに。

wp-includes/query.phpのget_postsを丁寧に調べていくと下記の部分で付け加えられていた。


// Taxonomies
 if ( !$this->is_singular ) {
 $this->parse_tax_query( $q );

$clauses = $this->tax_query->get_sql( $wpdb->posts, 'ID' );

$join .= $clauses['join'];
 $where .= $clauses['where'];
 }

ここのtax_query->get_sql() の部分。

今回このpre_get_postsではtax_queryを使用していなかったのでどうやらそれが原因らしい。

結果としては今回対象となるページが http://www.example.com/search/ なんていう検索用のURLだったんだけど、searchを普通のpostのcategoryとして見做していたようで、get_posts内の$this->tax_queryという$qを元に作られたタクソノミクエリでは


object(WP_Tax_Query)#9 (2) {
 ["queries"]=>
 array(1) {
 [0]=>
 array(5) {
 ["taxonomy"]=>
 string(8) "category"
 ["terms"]=>
 array(1) {
 [0]=>
 string(6) "search"
 }
 ["include_children"]=>
 bool(true)
 ["field"]=>
 string(4) "slug"
 ["operator"]=>
 string(2) "IN"
 }
 }
 ["relation"]=>
 string(3) "AND"
}

という状態に。

$qや$parsed_query、$wp_queryを調べてみると’category_name’に’search’が設定されていた。

これはパーマリンク設定で記事名を/%category%/%postname%/のようにしていたことで、最初のスラッシュからスラッシュの間をカテゴリ名として認識していたから、のようだ。

なのでpre_get_postsの中で


$query->set('category_name', '');

としてやることで不必要なtax_queryを省くことができた。

WordPressのペジネーションで、アーカイブページの「次の一覧」「前の一覧」を出す方法

WordPressのペジネーションで、アーカイブページの「次の一覧」「前の一覧」を出す方法

WordPressのペジネーションについて、次のページ、前のページだとか、1,2,3,4だとか、記事がたくさんある物に対してのページング、ペジネーションをやる必要があった。

ペジネーションって結構いろんな解決策があって、そして求められることがあって、それをどうやって実現しようかな、と。

今回のケースでは5件ずつ表示の投稿タイプで、次の5件、前の5件と、前後だけへのリンクが欲しかった。

こういう場合には posts_nav_link で解決!

http://codex.wordpress.org/Template_Tags/posts_nav_link

 

ちなみにこのcodexにもあるとおり、この関数の使い方でちょっとしたテクニックがあったりする。

この関数ってこれ一つで「前のページ」「次のページ」の両方を出してくれるんだけど、その際にコードを書く人が変更できるのは、この「前のページ」「後ろのページ」という、リンクの中に入っている文言だけだったり。

となると出力されるのが


<a href="foobar"><span class="iWantToAddClass">前のページ</span></a><a href="hogepiyo"><span class="uCoudInsert">次のページ</span></a>

というのはできても


<span class="nobodyCanMakeIt"><a href="foobar">前のページ</a></span><span class="beGod"><a href="hogepiyo">次のページ</a></span>

こういうのはできない。つまりaタグの内側はいじれるのでaの中にspanは入るけれど、aの外側にspanは付けれない。
CSSで前、次のそれぞれに違うクラスを付けて色つけする、っていうのはできない。

そこでcodexにあるようなやり方だとうまくいく。

<pre><div>
<div><?php posts_nav_link('','','&laquo; Previous Entries') ?></div>
<div><?php posts_nav_link('','Next Entries &raquo;','') ?></div>
</div></pre>

すごいね!

WordPressの記事でquery_postsをするとうまく通らないことがある

WordPressの記事でquery_posts、WP_Queryをするとうまく通らないことがある問題について。

PHPからWordPressの記事をいじってたんだけれどうまく取れないケースがあったのでメモ。

まずはうまく取れない条件について。

  1. カスタム投稿タイプの記事
  2. post_typeがfuture
  3. 上記に付して、投稿日時は2100-01-01みたいな未来
  4. post_name=hoge のように名前指定での取り出し

上記条件においてWP_Queryを利用するとうまく取れなかった。

ちなみに最後のpost_nameを指定しないとうまくいく。 うーんというところ。

$args = array(
  'name'=>'one_b38ptwd9', //コレを外すとうまくいく
  'post_type' => '1secwp',
  'post_status' => 'future',
);
$the_query = new WP_Query($args);
while ($the_query->have_posts()) {
  $the_query->the_post();
  // ここにこない
}

上記のコードだとうまくいかない。記事が存在するハズなのに記事が取得されない。WP_Queryインスタンスの$the_queryの持っている記事が0件となっていまう。
該当のコードを洗ってみる。wp-includes/query.phpの中盤あたりがそれ。

</pre>
if ( !empty($this->posts) && ($this->is_single || $this->is_page) ) {
  var_dump('hoge');
  exit;
  $status = get_post_status($this->posts[0]);
  $post_status_obj = get_post_status_object($status);
  var_dump($post_status_obj);
  //$type = get_post_type($this->posts[0]);
   if ( !$post_status_obj->public ) {
     if ( ! is_user_logged_in() ) {
     // User must be logged in to view unpublished posts.
     $this->posts = array();
   } else {
     if ( $post_status_obj->protected ) {
       // User must have edit permissions on the draft to preview.
       if ( ! current_user_can($edit_cap, $this->posts[0]->ID) ) {
         $this->posts = array();
       } else {

調べてみるとこのif文に入る条件となっている、

!empty($this->posts) && ($this->is_single || $this->is_page)

というのがおかしいことが原因。nameを指定市内と$this->is_singleがfalseなんだけど、nameを指定するとis_single=trueとなっちゃう。

そのせいで中盤にある

// User must be logged in to view unpublished posts.
$this->posts = array();

がひっかかってしまい、$this->postsが空っぽのarrayとなっちゃう。

というわけで解決方法は、この状態でログイン状態にしてやること、だ。

WordPressでログイン処理を強制的に行う方法
コードの最中にログインをする方法は上記に詳しい。

global $current_user;
$current_user = new WP_User(1);

これを加えてやっておしまい。

ちなみに記事が読めるか読めないか、みたいな詳細な権限は調べてないようなのでご注意。

WordPressのテーマ/テンプレート開発の時に役に立つコード

ダイエットが終わらない岡田洋一です、コンニチハ。

さて、最近ひょんなことからWordPressのテンプレートを修正する機会がありました。WordPressはで見た目をいじるときにはテーマ(テンプレート)ファイルを編集する必要があります。

WordPressでのページ表示には色々な仕組みがあるのですが、今回僕が編集することになったのは「カスタム投稿タイプのカスタムタクソノミーのアーカイブ」だったんです。この辺りについてはテンプレートヒエラルキーなんていう聞き慣れない仕組みが関わってきています。

さて、このテンプレートヒエラルキーというのは、簡単に言ってしまえば「テンプレートを適用する順序」を決めるモノなのです。「カスタムタクソノミーのアーカイブ」であれば「taxonomy-archive.php」とかになるのですが、これがなかなかうまく見つけられなかったりします。

さてこんな時、開発を行うにあたっては、現在どのテンプレートファイルを表示しているか、というのが分かると非常に助かります。

今回はこの「どのテンプレートファイルで表示しているか」を調べるためのコードを紹介します。

下記のコードを header.php の好きな位置に埋めて下さい。

<?php if(is_user_logged_in()) : ?></span>

<!-- <?php global $template; print_r($template); ?> -->
 <?php endif; ?>

Screen Shot 2013-10-01 at 4.48.45 PM

こうすることでHTMLのヘッダにコメントとして、「表示に使用しているテンプレート」が書き込まれます。

ちなみに if文で「ログインしている状態にのみ」に表示されるようになっていますので、知らない人には表示されません!ちょっと安心ですね。

Screen Shot 2013-10-01 at 4.55.28 PM

これでどのテンプレートを使っているか迷わずに開発ができますね!

リバースプロキシを使っているとWordPressで記事の参照がループしてしまう問題について

0. WordPressで記事の参照がループしてしまう問題について

WordPressで記事ページを開いたときに無限ループしてしまう。記事ページはいわゆるsingle.php シングルというページ。ブラウザの表示は

“このウェブページにはリダイレクト ループが含まれています” (chrome)
“ページの自動転送設定が正しくありません” (FireFox)

といった感じでループがおかしいという事を告げられる。
開発ツールで転送設定を見てみると、確かに同じアドレス宛に301の “Moved Permanently” が連続して返却されている。
このままでは利用者が入って来れないので調査をしてみた。

1

1. WordPressでのリダイレクト

WordPressで転送はwp-includes/canonical.phpというファイルが担当する。
このファイルはリクエストURLを見てカスタムパーマリンク設定などに照らし合わせて最適なURLへ誘導してくれる機能を持っている。

例えばパーマリンクを投稿名にしているとき、 http://www.example.com/?p=123 というURLへアクセスがあった場合、
http://www.example.com/test-post/ というパーマリンクへ301(こっちのURLが正しいですよ、というブラウザへの命令)などのコードで転送してやるのだ。

他にも http://www.example.com/test-pos/ なんていうのを http://www.example.com/test-post/ へ転送することも行っている。(推測です)

こういったことを担当しているcanonical.phpなんだけれど、その中身はちょっと複雑。主に301系の転送を担当してはいるものの、いろいろな処理が入り乱れている。

2. 問題点

そこでこの処理を超ナナメ読みして今回の問題点を洗い出すとこうだ。
以下に二つのURLがある。
パーマリンクを元に作成された、記事自体のパーマリンク。リダイレクトしたいURLを redirect_url と呼ぶ。
リダイレクトされる前の、実際に今アクセスされているURLを requested_url とする。
この二つが一致しないので延々とredurect_urlにリダイレクトさせようとしてしまっている。

canonical.phpにあるredirect_canonicalという関数。すでにかなーり縦長で読みにくい上、一度だけ自身を呼び出すプチ再帰になってるのでこれまたわかりにくい。中にデバッグ用のコードがコメントアウトされて配布されてるところをみても苦労が窺える。
canonical.phpにあるredirect_canonicalという関数。すでにかなーり縦長で読みにくい上、一度だけ自身を呼び出すプチ再帰になってるのでこれまたわかりにくい。
中にデバッグ用のコードがコメントアウトされて配布されてるところをみても苦労が窺える。

普通の情況であれば一度リダイレクトされればredirect_urlはrequested_urlとなるんだけれど、今回の問題は違った。
じつはこのrequested_urlは$_SERVERを元に作成される。サーバ環境変数。つまり見せかけ上のURL(ドメイン名)と実際にPHPが動いているドメイン名が違っていると無限ループする、というわけだ。
この見せかけ上のドメインとPHPが動いているサーバのドメイン名が違う、というのはリバースプロキシを使っていると起こってしまう。
リバースプロキシは大規模なウェブサイトになると負荷分散の為に用いられる手法だ。

今回このサイトではapacheのmod_proxyを利用した簡単なリバースプロキシを噛ましていた。
手前で動いていてWordPressに登録されているドメイン名はwww.example.comなのに、背後のウェブサーバではwww1.example.comという具合にドメイン名が違う。
なのでredirect_urlとrequested_urlが延々と違う、ということになってしまったのだ。

3. 解決方法

この問題を解決するにはいくつかの方法がある。
一つはcanonical.phpを書き換えてしまう方法。
requested_urlが$_SERVERから取得しているので該当部分を書き換えてしまえば良い。
ただしWordPressのコアファイルを書き換える、というのは禁断の果実を食べるに等しいのであまりオススメしない。

次にフィルタを書いてやる、という方法。redirect_url側をrequested_url側のドメイン名に揃えてやる、というやり方。これならば問題は起きにくいだろう。

// Note that you can use the "redirect_canonical" filter to cancel a canonical redirect for whatever reason by returning false
    $redirect_url = apply_filters('redirect_canonical', $redirect_url, $requested_url);

というわけでridirect_urlを書き換えるフィルタを書いてみました。これをfunctions.phpに加えておけばURLのドメイン部分がリバースプロキシの奥側のドメインに一致します。

add_action('redirect_canonical', 'change_requested_url');
function change_requested_url($redirect_url, $requested_url) {
 $redirect_url = is_ssl() ? 'https://' : 'http://';
 $redirect_url .= $_SERVER['HTTP_HOST'];
 $redirect_url .= $_SERVER['REQUEST_URI'];
 return $redirect_url;
}

今回のサイトでは複雑なクエリの組み立てなども行っていないのでこれで問題なさそうです。元のコードは先ほどのcanonical.phpから拝借してきました。

今回は見事、上記のフィルタ動作にてうまく動きました。めでたしめでたし。

WordPressでちょっとした項目をキャッシュしておく関数

WordPressでちょっとした項目をキャッシュしたい!というそんな要望からキャッシュ関数を作りました。

/**
* To cache data on wp_options.
* $callback function is call and store its data as serialized object.
* An optionname used in this function is  _periodic_cache_.$callback as defaul\
t.
*
* @return mixed */
function cache_($cache, $periodic = '1 hour', $param = array(),
$optionname = ''){
$optionname = $optionname
? $optionname
: '_periodic_cache_'.$callback;
$obj = get_option($optionname);
// revert $periodic to present time
if ($obj->modified < (time()*2 - strtotime($periodic)) ) {
$obj = new StdClass();
$obj->data = call_user_func_array($callback, $param);
$obj->modified = time();
update_option($optionname, $obj);
} else {
}
return $obj->data;
}

function c_($callback, $periodic='',$param = array(), $optionname=''){
return periodic_cache($callback, $periodic, $param, $optionname);
}

}

使い方は至って簡単。この関数の戻り値をキャッシュしたいな~、という時にこのキャッシュ関数を経由して呼び出せばOK。

例えばget_recent_posts()なんていう、最近の投稿一覧を取得する関数を作って、その値をキャッシュしたいのであれば


$posts = cach_('get_recent_posts', '20 hour', $param);

とすればおk。内部ではget_recent_posts()を$paramを引数として呼び出す。前回の呼び出しから20時間以内であればキャッシュを使用する。

これで簡単なものはキャッシュから読み出せるね。

削除の関数とかは作ってないよ。必要になったら作るかな~。

wordpressでよく引っかかる関数とか

ブログ全体に存在するカテゴリ(カスタムタクソノミー)全体の取得: get_categories()
ブログ全体に存在するカテゴリ(カスタムタクソノミー)全体の取得: get_terms()
ある記事のカテゴリ(カスタムタクソノミー)全体の取得: get_the_terms()
ある記事のカテゴリ(カスタムタクソノミー)全体の表示: the_terms()

あるタクソノミーのリンクを取得: get_term_link();
あるタクソノミーのオブジェクトを取得(id指定): get_term();
あるタクソノミーのオブジェクトを取得(名前他指定): get_term_by();

ブログの記事が見つからなかったときトップページに飛ばす方法

WordPressの記事が見つからなかったときにトップページに飛ばす方法について。404 on chrome

WordPressで記事を書いたり作ったりしていると記事が無いことがある。原因は主に二通りで、一つはリンク先のアドレスを間違えてしまったリンクミス、もう一つは過去には存在したけれど削除されてしまったケース。

これらのケースにおいてWordPressではどんな対応を取るべきなだろうか。

WordPressではデフォルトで404.phpというテーマファイルがくっついてくる。
これはHTTP Status Codeが404の場合、つまり記事が見つからなかった場合に表示されるページのテーマだ。
“おっと、失礼しました。”と表示されるのはこの404.phpが表示されるケースだ。

ブログの運営方針にもよるが、今回は記事が見つからなかった場合にトップページに飛ばすことにした。
ここで注意しなければいけないことが二点。
一つはトップページに“飛ばす”ということ。実はテンプレートヒエラルキーなんていうムズカシイ言葉があって、404.phpを削除するだけで”記事が見つからなかった場合にトップページを表示“させることができる。このやり方だと見た目はトップページなんだけれどURLが無くなった記事そのままになってしまう。これはダサい。
注意点の二つ目はHTTP Status Code。HTTPステータスコードというのはブラウザに送る機械的な意味だ。良く目にする404というのは”記事が見つかりませんでした”という意味を確実に的確に機械的にブラウザに伝えるための番号なのだ。
さて実はこのHTTPステータスコードなんだけれど、その確実性ゆえ、検索エンジンにも番号は理解される。つまり記事ID123番のページに検索エンジンのボットが来た、でも記事がないよーというとき、404を返しておけば「このページは削除されたんだね」と解釈してくれる。(厳密にはそうで無い場合もあるのだけれど)
なので極力このステータスコードを返してあげた方が良い。

というわけでfunctinons.phpあたりにこのへんをまとめて書いてみた。


add_action('wp_head', 'redirectToIndex');
function redirectToIndex() {
if (is_404()) {
header('HTTP/1.0 404 Not Found');
header('Location: '.get_bloginfo('url').'/');
}
}

これで404を送りつつLocationを指定してページをジャンプさせることができる。Locationの行を変えることでジャンプ先を任意のページにすることもできる。

 

おわりに
HTTPステータスコードはなんだかなじみが無くてなかなか利用価値がわからなかったりするんだけれど、例えばサーバの負荷を減らすためのキャッシュの制御だったりだとか、一時的なメンテナンスを通知したりだとか、そういった用途に使える。
とくにメンテナンス通知に使われる503は日時指定もできて何時何分ごろには復旧しますよー、なんてこともできたりする。
検索エンジンにメンテナンス画面がキャッシュされてしまうことも防げたり、これは防げないこともあったり。でも気を遣うに超したことはないよね。

 

というわけで404をリダイレクトでジャンプさせる、でした。