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

最終更新 : 2021年07月27日 10:04



お勧め

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。