wp_revisions_to_keep

説明

int wp_revisions_to_keep( WP_Post $post )
投稿情報のリビジョン数を取得する。

パラメータ

  • $post
    投稿情報を指定。

返り値

投稿情報のリビジョン数を返す。


注意

保持するリビジョン数(数値またはtrue)を定義する WP_POST_REVISIONSを参照している。この定数がwp-config.php内で定義されている場合はその値が有効となり、定義されていない場合はtrueが定義される。WP_POST_REVISIONSがtrueの場合、この関数内ではリビジョン数が-1となる。

パラメータ$postの投稿タイプが'revisions'をサポートしていない場合、リビジョン数はWP_POST_REVISIONSの値に関わらず0となる。

[5.8.0]'wp_revisions_to_keep'フィルターの後に"wp_{$post->post_type}_revisions_to_keep"フィルター('wp_post_revisions_to_keep'や'wp_page_revisions_to_keep'など)が追加される。


使用例

  • 投稿情報のリビジョン数を取得する。
    $num = wp_revisions_to_keep( $post );

フィルター

[3.6.0]リビジョン数を返す前に'wp_revisions_to_keep'フィルターを呼び出す。パラメータ$numにはリビジョン数が、$postには本関数が受け取った内容が格納されている。
return (int) $num = apply_filters( 'wp_revisions_to_keep', $num, $post );
[5.8.0]'wp_revisions_to_keep'フィルターの後に"wp_{$post->post_type}_revisions_to_keep"フィルターを呼び出す。パラメータ$numにはリビジョン数が、$postには本関数が受け取った内容が格納されている。
$num = apply_filters( "wp_{$post->post_type}_revisions_to_keep", $num, $post );

アクション

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

ソースファイル

/wp-includes/revision.php

最終更新 : 2023年04月04日 11:31



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

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

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

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。