- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
関数リファレンス/add permastruct
提供: WordPress Codex 日本語版
< 関数リファレンス
2015年9月5日 (土) 23:40時点におけるMiccweb (トーク | 投稿記録)による版 (→関連: {{原文|Function Reference/add_permastruct|129378}} <!--01:36, 30 March 2013 Funkatronic -->)
このページ「関数リファレンス/add permastruct」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています。
説明
add_permastruct() は、WordPressのための追加のパーマリンク構造を指定することができます。ほとんど全ての場合、add_rewrite_tag() と add_rewrite_rule() と一緒に用いられます。
使い方
add_permastruct($name, $struct, $args);
パラメータ
- $name
- (string) (必須) パーマリンク構造の名前
- 初期値: なし
- $struct
- (string) (必須) パーマリンク構造
- 初期値: なし
- $args
- (array) (optional) パーマリンク構造から、リライトルールを生成するときのオプション設定。詳細は WP_Rewrite::add_permastruct() っを参照して下さい。
- 初期値: array
設定可能な値
- with_front
- (boolean) WP_Rewrite::$front をパーマリンク構造の前に配置するべきか。デフォルトはtrue.
- ep_mask
- (integer) Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE.
- paged
- (boolean) ページネーションためのリライトルールを追加するかどうか。 Default is true.
- feed
- (boolean) フィードのリライトルールを追加するかどうか。 Default is true.
- forcomments
- (boolean) コメントフィードのクエリのためのルールかどうか。 Default is false.
- walk_dirs
- (boolean) Should the 'directories' making up the structure be walked over and rewrite rules built for each in turn? Default is true.
- endpoints
- (boolean) エンドポイントは、生成されたリライトルールに適用されるべきか。 Default is true.
ソースファイル
add_permastruct() は wp-includes/rewrite.php
にあります。
関連
記事
- レッスン: Rewrite API 概要
- クラス: WP_Rewrite() - WordPress のビルトイン URL リライトクラスに関する概要。
フック
- フィルター: root_rewrite_rules /en - ブログのルート用に生成されたリライトルールをフィルターする。
- フィルター: post_rewrite_rules /en - パーマリンク URL 向けに生成されたリライトルールをフィルターする。
- フィルター: page_rewrite_rules /en - 固定ページ向けに生成されたリライトルールをフィルターする。
- フィルター: date_rewrite_rules /en - 日付ごとのアーカイブ URL 向けに生成されたリライトルールをフィルターする。
- フィルター: search_rewrite_rules /en - 検索 URL 向けに生成されたリライトルールをフィルターする。
- フィルター: comments_rewrite_rules /en - 最新コメントフィード URL 向けに生成されたリライトルールをフィルターする。
- フィルター: author_rewrite_rules /en - 投稿者アーカイブ URL 向けに生成されたリライトルールをフィルターする。
- フィルター: rewrite_rules_array /en - すべてのリライトルールを一度にフィルターする。
- フィルター: {$permastruct}_rewrite_rules /en - タクソノミーやカスタム投稿タイプなどのカスタムパーマストラクト向けのリライトルールを作成・編集するために使える。
- アクション: generate_rewrite_rules /en - すべてのルールが生成された後に実行される。
関数
- add_rewrite_tag() / en - WordPress にカスタム変数 (特に、カスタムクエリストリング変数) を認識させるために使える。
- add_rewrite_rule() / en - 新しいカスタムリライトルールを指定できる。
- add_rewrite_endpoint() / en - /trackback/ などの新規エンドポイントを追加する。
- flush_rules() / en - リライトルールを再生成してデータベースに保存する。
- flush_rewrite_rules() / en - リライトルールを削除して再生成する。
- generate_rewrite_rules() / en - パーマリンク構造からリライトルールを生成する。
- add_permastruct() / en - 新規パーマストラクトを追加する。
- add_feed() / en - /atom1/ のような新規フィードタイプを追加する。
関数リファレンス、テンプレートタグ目次もご覧ください。
最新英語版: WordPress Codex » Function Reference/add_permastruct (最新版との差分)