_sync_custom_logo_to_site_logo()


WordPressの_sync_custom_logo_to_site_logo()関数は、カスタムロゴをサイトロゴと同期させるために使用されます。この関数は、テーマカスタマイザーで設定されたカスタムロゴを取得し、サイトロゴとして設定します。

構文

_sync_custom_logo_to_site_logo( int $blog_id = null );
  • $blog_id(int) — 同期を行うブログのID。デフォルトはnullで、現在のブログを指します。

例1: カスタムロゴをサイトロゴに同期

この例では、現在のブログのカスタムロゴをサイトロゴに同期させます。

_sync_custom_logo_to_site_logo();

例2: 特定のブログのカスタムロゴを同期

この例では、指定したブログIDのカスタムロゴをサイトロゴに同期させます。

_sync_custom_logo_to_site_logo(2);

例3: カスタムロゴの同期をフックで実行

この例では、initフックを使用して、カスタムロゴの同期を自動的に実行します。

add_action('init', function() { _sync_custom_logo_to_site_logo(); });

例4: カスタムロゴの同期を条件付きで実行

この例では、特定の条件が満たされた場合にのみカスタムロゴの同期を実行します。

if (get_option('sync_logo')) { _sync_custom_logo_to_site_logo(); }

例5: カスタムロゴの同期をカスタマイザー保存時に実行

この例では、カスタマイザーの設定が保存された時にカスタムロゴの同期を実行します。

add_action('customize_save_after', function() { _sync_custom_logo_to_site_logo(); });

例6: カスタムロゴの同期を手動でトリガー

この例では、管理画面から手動でカスタムロゴの同期をトリガーします。

add_action('admin_init', function() { if (isset($_GET['sync_logo'])) { _sync_custom_logo_to_site_logo(); } });

例7: カスタムロゴの同期をログに記録

この例では、カスタムロゴの同期が実行された際にログに記録します。

add_action('init', function() { error_log('Custom logo synced'); _sync_custom_logo_to_site_logo(); });

注意点

  • この関数は、テーマカスタマイザーでカスタムロゴが設定されている場合にのみ動作します。
  • マルチサイト環境では、適切なブログIDを指定する必要があります。
  • カスタムロゴの同期は、サイトロゴがサポートされているテーマでのみ有効です。

関連機能：