wp_unique_post_slug

パラメータ

• $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 ); ?>

フィルター

$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 );

アクション

ソースファイル