wp_unique_post_slug

説明

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で確認)。


使用例

  • $postからユニークな投稿スラッグを取得する。
    <?php $post_name = wp_unique_post_slug( sanitize_title( $post->post_title ), $post->ID, $post->post_status, $post->post_type, $post->post_parent ); ?>

フィルター

ユニークになった投稿スラッグを返す直前に'wp_unique_post_slug'フィルターを呼び出す。パラメータ$slugはユニークになった投稿スラッグ、$original_slugは本関数のパラメータ$slugの内容が格納される。
return apply_filters( 'wp_unique_post_slug', $slug, $post_ID, $post_status, $post_type, $post_parent, $original_slug );

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2014年11月27日 15:38



お勧め

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

Gutenberg、「新規追加」に難あり(2018年10月25日 更新)

昨日公開した「Gutenberg、初見です」で自作プラグインの「複製」機能が正しく動作していないことについて軽く触れた。該当するプラグインを修正するにしても原因がはっきりしないと手の打ちようがない。そんなわけで、不具合の原因を調べてみた。

「テキスト」モードと「ビジュアル」モードを行き来すると投稿内容の一部が消える(2018年5月27日 更新)

仕事がらサイトの引っ越し作業のお手伝いをすることがあるのですが、今回は引っ越しにあわせてWordPressを「3.7.1」から最新版「4.1.1」にアップデートすることになりました。ここで紹介するのはこの案件で発生したトラブルの話です。