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



お勧め

カスタムフィールドで並び替え(2013年8月9日 更新)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

開発環境(Windows 8)にimagickを入れる(2012年12月23日 更新)

WordPress 3.5のイメージエディタ(WP_Image_Editor)は、GDだけでなく、imagick(ImageMagick)にも対応している。そんなわけでWindows 8の開発環境にimagickをインストールしてみた。

ページを表示する直前の前処理にtemplate_redirectアクションを(2013年4月13日 更新)

リクエストに応じてページを表示する直前の準備として何かしらの処理を行っておきたいケースがある。そんな時、テーマの各テンプレートファイルの先頭部分に処理内容をずらずらと記述していませんか。

Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。