add_permastruct

説明

void add_permastruct( string $name, string $struct [ , mixed $args = array() ] )
投稿タイプのパーマリンク設定を追加する。

パラメータ

  • $name
    投稿タイプ名を指定。
  • $struct
    パーマリンクのURLパターンを指定。
  • $args
    パーマリンク設定の属性を連想配列で指定。
    キーデフォルト値
    'with_front'booltrue
    'ep_mask'intEP_NONE(0)
    'paged'booltrue
    'feed'booltrue
    'forcomments'boolfalse
    'walk_dirs'booltrue
    'endpoints'booltrue

返り値

返り値はありません。

注意

本関数は3.4でパラメータ仕様が変更されている。3.0~3.3までの呼び出し形式は次の通りで、3.4以降の環境において下記の指定で呼び出された場合でも互換性は保たれている。
add_permastruct( string $name, string $struct [ , bool $with_front = true [ , int $ep_mask = EP_NONE ] ] )
パーマリンクのURLパターンは、末尾の'/'が無視される以外に制限はなく、日本語を使用する場合はそのまま(URLエンコードは不要)指定できる。
なお本関数で追加したパーマリンク設定はそのままではシステムに反映されないため、適宜 flush_rewrite_rules関数を呼び出すか、管理者ページの「設定」-「パーマリンク設定」を開き、「変更を保存」ボタンをクリックする必要がある。

使用例

  • カスタム投稿タイプ'tool'のパーマリンクに拡張子htmlを設定する。
    <?php add_permastruct( 'tool', 'tool/%tool%.html', array( 'ep_mask'=>EP_PERMALINK ) ); ?>
  • カスタム投稿タイプ'tool'のパーマリンクのディレクトリ名を'tool'から'道具'に変更する。
    <?php add_permastruct( 'tool', '道具/%tool%', array( 'ep_mask'=>EP_PERMALINK ) ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/rewrite.php

最終更新 : 2012年09月06日 16:21



お勧め

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。