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 - 投稿情報

お勧めコンテンツ

カスタムフィールド関連関数のおさらい(2012年6月22日 登録)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

管理者ページに文言を表示する(2012年4月19日 登録)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

絵文字画像がPNGからSVGへ(2016年8月15日 登録)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

テーマから投稿画像のサイズを指定する(2012年3月15日 登録)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

投稿情報を連想配列で参照する(2014年11月16日 登録)

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

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