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



お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。