説明
string wp_unique_post_slug( string $slug, int $post_ID, string $post_status, string $post_type, int $post_parent )
ユニークな投稿スラッグを取得する。
パラメータ
- $slugサニタイズした投稿名を指定。
- $post_ID投稿IDを指定。
- $post_status投稿ステータスで指定。
- $post_type投稿タイプを指定。
- $post_parent親の投稿IDを指定（親がない場合は0）。
返り値
ユニークな投稿スラッグを返す。注意
サイト全体でユニークとなる投稿スラッグ（同じ名前がすでにある場合は-1や-2のようなサフィックスが付く）を取得できるもので、通常は wp_insert_post関数内で呼ばれている。基本的に呼び出すことはなく、利用するなら'wp_unique_post_slug'フィルターだろう。
なお、パラメータ$post_statusが'draft'、'pending'、'auto-draft'のいずれかか、パラメータ$post_statusが'inherit'でパラメータ$post_typeが'revision'の場合はパラメータ$slugをすぐに返す（フィルターは呼び出されない）。
【重要】
'wp_unique_post_slug'フィルターを利用する場合は、その戻り値となるスラッグがURLエンコード（PHP urlencode関数など）して200文字を超えないようにすること。200文字を超えたスラッグを返した場合はその投稿情報は正しく保存されない（3.7.1で確認）。
[5.1.0]本関数でユニークなスラッグを生成する前に'pre_wp_unique_post_slug'フィルターが追加され、独自ルールでスラッグを生成する場合は従来の'wp_unique_post_slug'フィルターの代わりに使用できる。
使用例
- $postからユニークな投稿スラッグを取得する。<?php $post_name = wp_unique_post_slug( sanitize_title( $post->post_title ), $post->ID, $post->post_status, $post->post_type, $post->post_parent ); ?>
フィルター
[5.1.0]ユニークなスラッグを生成する前に'pre_wp_unique_post_slug'フィルターを呼び出す。パラメータ$override_slugにはnullが、以降のパラメータには本関数が受け取った内容が格納されている。$override_slug = apply_filters( 'pre_wp_unique_post_slug', $override_slug, $slug, $post_ID, $post_status, $post_type, $post_parent );return apply_filters( 'wp_unique_post_slug', $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug );アクション
直接実行するアクションはありません。ソースファイル
/wp-includes/post.php最終更新 : 2019年03月01日 14:51
関連
お勧め
管理画面でツールバー（Admin bar）を非表示にする（2013年3月5日 更新）
WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。タイトルが一致する投稿を検索する（2014年2月20日 更新）
WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数（WP_Queryクラス）が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数（WP_Queryクラス）の使用法の一例である。
投稿ページでユニークなテンプレートを選択しよう（2018年5月27日 更新）
4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ（'page'）向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ（'post'）はもちろんカスタム投稿タイプのページにも適用可能になっている。
WordPressの鼓動（2013年10月1日 更新）
WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。