WordPressのプラグイン作成：カスタム投稿タイプの作成

やりたいこと：カスタム投稿タイプ（Custom Post Type）のUIを日本語化

• 前回紹介したカスタム投稿タイプ、多言語翻訳用のPOT/PO/MOファイル
  • WordPressの新規投稿タイプ１：functions.phpファイルに定義する方法
  • WordPressの多言語翻訳１：POT,PO,MOファイルの理解と作成
• 作成したカスタム投稿タイプのユーザーインターファイルを日本語化します
  

カスタム投稿タイプUIの日本語翻訳ファイル（PO/MO）を作成します

• Poeditで日本語翻訳ファイル（PO）を作成します

  msgid ""
  msgstr ""
  "MIME-Version: 1.0\n"
  "Content-Type: text/plain; charset=UTF-8\n"
  "Content-Transfer-Encoding: 8bit\n"
  "Plural-Forms: nplurals=1; plural=0;\n"
  "X-Generator: Poedit 2.0.3\n"
  "Language: ja_JP\n"
  "Project-Id-Version: \n"
  "POT-Creation-Date: \n"
  "PO-Revision-Date: \n"
  "Last-Translator: \n"
  "Language-Team: \n"
  
  msgid "Products"
  msgstr "製品投稿"
  
  msgid "Product"
  msgstr "製品"
  
  msgid "Add New"
  msgstr "新規作成"
  
  msgid "Add New Product"
  msgstr "新規製品作成"
  
  msgid "Edit Product"
  msgstr "製品編集"
  
  msgid "New Product"
  msgstr "新規製品"
  
  msgid "All Products"
  msgstr "全製品"
  
  msgid "View Product"
  msgstr "製品表示"
  
  msgid "Search Products"
  msgstr "製品検"
  
  msgid "No products found"
  msgstr "製品を見つからない"
  
  msgid "No products found in the Trash"
  msgstr "ゴミ箱から製品を見つからない"
  

• 上記POファイルをPoeditでコンパイルしてMOファイルに変換します

翻訳ファイルの配置は：{所属しているテーマフォルダ内} or {WPの言語フォルダ内}

• 翻訳ファイルは所属しているテーマのフォルダ内に配置することができます
  • 今回の例では twentyseventeen-child （twentyseventeenの子テーマ）
  • 翻訳ファイルの命名規則： {locale}.po、{locale}.mo
    • localeは日本語の場合： ja.po、ja.mo となります
  • テーマフィールドに「languages」フォルダを作成、その下に配置します
    
• WPの言語フォルダに配置することもできます
  • WPの言語フォルダ：wp-content/languages
  • 翻訳ファイルの命名規則： {domain}-{locale}.po、{domain}-{locale}.mo
    • 今回の例のテキストドメイン（text domain）名： product
    • 翻訳ファイル名：product-ja.po、product-ja.mo
  • 翻訳ファイル名を変更して、WPの言語フォルダに配置します
    

カスタム投稿タイプ登録する前に作成した翻訳ファイルをロードします

• WPの言語フォルダに配置する場合、翻訳フォイルのロード記述する必要はありません（自動ロードとなります）
• 所属しているテーマのフォルダに配置する場合、翻訳ファイルをロードする記述は必要となります
  • カスタム投稿タイプ登録（functions.php）する前にロードが必要です

    // 翻訳ファイルをロード
    load_theme_textdomain("product", get_stylesheet_directory() . '/languages');
    
    // カスタム投稿タイプ登録
    add_action( 'init', 'my_custom_post_product' );
    

  • 翻訳ファイルのディレクト取得関数：get_stylesheet_directory() なので、get_stylesheet_directory_url()ではありません（後者の場合、翻訳ファイルのロードはできません）。また、get_template_directory()関数の使用はできません（これは親テーマのディレクトリを取得する）
  • load_child_theme_textdomain()で翻訳ファイルのロードもできます

カスタム投稿タイプ（Custom Post Type）がテーマ（Theme）に依存しないように自作プラグイン（Plugin）に入れます

• 前回紹介したカスタム投稿タイプはそのテーマのfunctions.phpに定義しています
  • WordPressの新規投稿タイプ１：functions.phpファイルに定義する方法
• WordPressのテーマを変えたら、カスタム投稿タイプが消えてしまう問題が発生します（そのテーマのみに使用する場合は問題はありません）
• テーマを依存しないように、カスタム投稿タイプを自作のプラグインに入れます

自作プラグイン（Plugin）名とフォルダ名のほかのプラグインに重複してはいけません

• プラグイン名はユニックで、インストールしたほかのプラグイン名に重複してはいけません
  • 将来プラグインをインストールすることもあるので、WordPressのプラグイン名をチェックし他方が良いでしょう
• プラグインのフォルダ名もインストールしたほかのプラグインフォルダ名と衝突してはいけません
• プラグインフォルダに最低一つのphpファイル（プラグインの定義、動作記述）が必要です
  • phpファイル名がよくフォルダ名と同じようにつけていますが、必ず一致する必要はありません
• 自作プラグイン（例：product-custom-type）をWordPressのプラグインフォルダ（wp-content/plugins）の下に置きます
  
• 目的に合わせて、プラグインのフォルダに子フォルダの作成ができます（例：UI翻訳ファイルを置くフォルダ：languages）
• セキュリティ配慮：有効化されていないプラグインのファイルアクセスをブロックすべきです
  • 有効化されていないプラグインファイル（php）の直接アクセスが可能です（URLが直接にファイルを指定すればできます）
  • プラグインが有効化していないので、直接にアクセスされた、不意な動作が発生してしまう可能性があります
  • 有効化されていないプラグインファイルをアクセスブロックは以下のコードで防ぐことができます

    // プラグインファイルの先頭に置きます
    // ABSPATH 定数が定義されていない場合、プラグインが有効かされていない
    defined( 'ABSPATH' ) or die( 'No script kiddies please!' );

プラグイン（Plugin）定義をコメントでphpファイルの上に置きます

• プラグイン名、バージョン、説明、作者などの情報をプラグインファイル（例：product-post-type.php）の先頭にコメントをつけて置きます

  <?php
  /*
  Plugin Name: Product Post Type
  Plugin URI: http://old-pine.net
  Description: Product of the custom post type which created with a new custom plugin
  Version: 1.0
  Author: Old-pine
  Author URI: http://old-pine.net/
  License: GPLv2
  */

  

カスタム投稿タイプの定義をプラグインファイルに書きます

• カスタム投稿タイプの定義（前回紹介したもの同じ）プラグイン（phpファイル）に書き込みます

  <?php
  /*
  Plugin Name: Product Post Type
  Plugin URI: http://old-pine.net
  Description: Product of the custom post type which created with a new custom plugin
  Version: 1.0
  Author: Old-pine
  Author URI: http://old-pine.net/
  License: GPLv2
  */
  
  defined( 'ABSPATH' ) or die( 'No script kiddies please!' );
  
  load_plugin_textdomain("product",false ,  'product-post-type/languages');
  
  add_action( 'init', 'my_custom_post_product' );
  function my_custom_post_product() {
      $labels = array(
          'name'               => _x( 'Products', 'post type general name', 'product' ),
          'singular_name'      => _x( 'Product', 'post type singular name', 'product' ),
          'add_new'            => _x( 'Add New', 'post type singular name', 'product' ),
          'add_new_item'       => __( 'Add New Product', 'product' ),
          'edit_item'          => __( 'Edit Product', 'product' ),
          'new_item'           => __( 'New Product', 'product' ),
          'all_items'          => __( 'All Products', 'product' ),
          'view_item'          => __( 'View Product', 'product' ),
          'search_items'       => __( 'Search Products', 'product' ),
          'not_found'          => __( 'No products found', 'product' ),
          'not_found_in_trash' => __( 'No products found in the Trash', 'product' ),
          'parent_item_colon'  => '',
          'menu_name'          => __('Products', 'product'),
      );
      $args = array(
          'labels'        		=> $labels,
          'description'   		=> 'Holds our products and product specific data',
          'public'        		=> true,
          'menu_position' 		=> 5,
          'supports'      		=> array( 'title', 'editor', 'thumbnail', 'excerpt', 'comments' ),
          'has_archive'   		=> true,
          'hierarchical'          => false,
          'show_ui'               => true,
          'show_in_menu'          => true,
          'menu_position'         => 5,
          'show_in_admin_bar'     => true,
          'show_in_nav_menus'     => true,
          'can_export'            => true,
          'has_archive'           => true,
          'exclude_from_search'   => false,
          'publicly_queryable'    => true,
          'capability_type'       => 'page',
      );
      register_post_type( 'product', $args );
  }
  

• 上記定義をすれば、プラグイン管理画面に「Product Post Type」プラグインが現れます
  • 通常にプラグイン有効化操作でよいです

プラグインのUI翻訳ファイル（PO/MO）：{WordPressグロバル言語フォルダ} or {プラグインのフォルダ}

• プラグインのUI翻訳ファイルは二か所に置くことができます
  • WordPressグロバル言語フォルダ： wp-content/languages
  • プラグインフォルダ内： wp-content/plugins/product-post-type
• 前回紹介したカスタム投稿タイプの翻訳ファイル（PO/MO）の作成方法は同じです
  • WordPressの新規投稿タイプ２：ユーザーインターフェースの翻訳方法
• 翻訳ファイルの名前： {domain}-{locale}.mo
  • 前回のテーマフォルダに言語ファイル：{locale}.mo と違います
• 翻訳ファイルを取り入れhookは； load_plugin_textdomain() を使用します

  load_plugin_textdomain("product",false ,  'product-post-type/languages');

  • 前回のhookは：load_theme_textdomain() を使用しました

やりたいこと：カスタム投稿タイプ（Custom Post Type）のUIを日本語化

• 前回紹介したカスタム投稿タイプ、多言語翻訳用のPOT/PO/MOファイル
  • WordPressの新規投稿タイプ１：functions.phpファイルに定義する方法
  • WordPressの多言語翻訳１：POT,PO,MOファイルの理解と作成
• 作成したカスタム投稿タイプのユーザーインターファイルを日本語化します
  

カスタム投稿タイプUIの日本語翻訳ファイル（PO/MO）を作成します

• Poeditで日本語翻訳ファイル（PO）を作成します

  msgid ""
  msgstr ""
  "MIME-Version: 1.0\n"
  "Content-Type: text/plain; charset=UTF-8\n"
  "Content-Transfer-Encoding: 8bit\n"
  "Plural-Forms: nplurals=1; plural=0;\n"
  "X-Generator: Poedit 2.0.3\n"
  "Language: ja_JP\n"
  "Project-Id-Version: \n"
  "POT-Creation-Date: \n"
  "PO-Revision-Date: \n"
  "Last-Translator: \n"
  "Language-Team: \n"
  
  msgid "Products"
  msgstr "製品投稿"
  
  msgid "Product"
  msgstr "製品"
  
  msgid "Add New"
  msgstr "新規作成"
  
  msgid "Add New Product"
  msgstr "新規製品作成"
  
  msgid "Edit Product"
  msgstr "製品編集"
  
  msgid "New Product"
  msgstr "新規製品"
  
  msgid "All Products"
  msgstr "全製品"
  
  msgid "View Product"
  msgstr "製品表示"
  
  msgid "Search Products"
  msgstr "製品検"
  
  msgid "No products found"
  msgstr "製品を見つからない"
  
  msgid "No products found in the Trash"
  msgstr "ゴミ箱から製品を見つからない"
  

• 上記POファイルをPoeditでコンパイルしてMOファイルに変換します

翻訳ファイルの配置は：{所属しているテーマフォルダ内} or {WPの言語フォルダ内}

• 翻訳ファイルは所属しているテーマのフォルダ内に配置することができます
  • 今回の例では twentyseventeen-child （twentyseventeenの子テーマ）
  • 翻訳ファイルの命名規則： {locale}.po、{locale}.mo
    • localeは日本語の場合： ja.po、ja.mo となります
  • テーマフィールドに「languages」フォルダを作成、その下に配置します
    
• WPの言語フォルダに配置することもできます
  • WPの言語フォルダ：wp-content/languages
  • 翻訳ファイルの命名規則： {domain}-{locale}.po、{domain}-{locale}.mo
    • 今回の例のテキストドメイン（text domain）名： product
    • 翻訳ファイル名：product-ja.po、product-ja.mo
  • 翻訳ファイル名を変更して、WPの言語フォルダに配置します
    

カスタム投稿タイプ登録する前に作成した翻訳ファイルをロードします

• WPの言語フォルダに配置する場合、翻訳フォイルのロード記述する必要はありません（自動ロードとなります）
• 所属しているテーマのフォルダに配置する場合、翻訳ファイルをロードする記述は必要となります
  • カスタム投稿タイプ登録（functions.php）する前にロードが必要です

    // 翻訳ファイルをロード
    load_theme_textdomain("product", get_stylesheet_directory() . '/languages');
    
    // カスタム投稿タイプ登録
    add_action( 'init', 'my_custom_post_product' );
    

  • 翻訳ファイルのディレクト取得関数：get_stylesheet_directory() なので、get_stylesheet_directory_url()ではありません（後者の場合、翻訳ファイルのロードはできません）。また、get_template_directory()関数の使用はできません（これは親テーマのディレクトリを取得する）
  • load_child_theme_textdomain()で翻訳ファイルのロードもできます