post_password_required

(2.7.0以降)
post_password_required - 投稿ページのパスワード保護状態を調べる

説明

bool post_password_required( [ mixed $post = null ] )
投稿ページがパスワード保護状態を調べる。

パラメータ

  • $post
    パスワード保護状態を調べる投稿情報またはその投稿IDを指定(省略時は現在の投稿情報を調べる)。

返り値

投稿ページがパスワード保護されていて利用者のクッキーにパスワードが含まれているか、パスワードが一致しない場合はtrueを返す。それ以外の場合はfalseを返す。

注意

パスワード保護は投稿情報別に設定されるもので、管理者ページの投稿編集の公開状態で変更できる(通常は一般公開)。

使用例

  • 現在の投稿ページのパスワード保護状態を調べる。
    <?php if ( post_password_required() ) { ?>

フィルター

[4.7.0]パスワードが必要かを返す前に'post_password_required'フィルターを呼び出す。パラメータ$requiredにはパスワードが必要かどうかの判定内容が、$postには対象の投稿情報(パラメータとして受け取った内容と異なる場合がある)が格納されている。
return apply_filters( 'post_password_required', $required, $post );

アクション

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

ソースファイル

/wp-includes/post-template.php

関連

  • get_the_content - 現在の投稿情報のコンテンツを取得する
  • get_the_password_form - パスワード保護されている投稿のパスワード入力フォームを取得する
  • $post - 投稿情報

お勧めコンテンツ

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 登録)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

時代はWP_Queryなのか(2011年8月1日 登録)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近までget_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

投稿ページにキーワード検索ウィジェットを追加する(2012年6月2日 登録)

「投稿の編集」ページで記事を編集していると、関連する投稿記事を検索したくなることがある。そんな時、「投稿一覧」ページに戻って「キーワード検索」を行えばいいのだが、そのひと手間がちょっとだけ煩わしい。

RSSフィードの抜粋をさらに抜粋(2011年7月21日 登録)

RSSフィードはデフォルトでは「全文(HTMLタグを含む)」になっているが、管理画面の「表示設定」では「抜粋のみ(HTMLタグは除外)」を選択できる。それでも投稿記事が長いと、その抜粋テキストも長くなってしまう。ここではそんなRSSフィードの抜粋テキストを調整する方法を紹介する。

投稿内容に応じてwpautopを制御する(2013年8月13日 登録)

投稿内容を表示するthe_content関数では、wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

最終更新日時 : 2017-01-11 15:45