wp_set_option_autoload

説明

bool wp_set_option_autoload( string $option, string | bool $autoload )
オプションのオートロードを設定・解除する。

パラメータ

  • $option
    オートロードを変更するオプション名を指定。
  • $autoload
    オートロードするオプション場合は'yes'かtrueを、オートロードしない場合は'no'かfalseを指定。

返り値

オプションのオートロードを変更した場合はtrueを返す。変更できなかった場合はfalseを返す。

注意

本関数はプラグインなどが登録した1つのオプションをオートロードするようにしたり、その逆にオートロードしないようにする場合に使用する。関連するデータベースのほかキャッシュも更新される。

本関数はパラメータ$optionをキーに、$autoloadを値として連想配列を作成し、それを wp_set_option_autoload_values関数へ引き継いでいる。

パラメータ$autoloadの値は、厳密には'no'かfalseを判定し、それら以外は'yes'かtrueと同じ意味となる。

[6.7.0]パラメータ$autoloadの値は、'yes'と'no'が非推奨になった。


使用例

  • オプション'myplugin_setting1'のオートロード指定を設定する
    wp_set_option_autoload( 'myplugin_setting1', true );

フィルター

直接実行するフィルターはありません。

アクション

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

ソースファイル

/wp-includes/option.php

最終更新 : 2024年12月18日 13:13



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

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

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

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。