wordpress get_option()函数


【函数介绍】

get_option()用于获取通过option表单设置值得方法,如果数据库中不存在该选项,或者该选项的值为空,则返回FALSE.

【函数使用】

  1. <?php echo get_option( $option, $default ); ?>

【参数说明】

$option
(string) (必须) 查询选项的名称. 数据库中已存在的选项名称如下(这些都在后台的“菜单”=》“常规”):

  • 'admin_email' – 管理员的E-mail地址.
  • 'blogname' – 网站title标题.
  • 'blogdescription' – 网站描述.
  • 'blog_charset' – 网站编码一般UTF-8.
  • 'date_format' – 日期格式.
  • 'default_category' – 文章默认分类.
  • 'home' – 网站地址.
  • 'siteurl' – wordpress的web地址.
    主题: 此选项与函数 get_bloginfo('siteurl')不同 get_bloginfo('siteurl')返回当前站地址, 但是这个选项等同于get_bloginfo('wpurl');.
  • 'template' -当前主题名称
  • 'start_of_week' -一星期开始设置
  • 'upload_path' – 上传默认目录.
  • 'posts_per_page' – 文章分页每页显示的数量.
  • 'posts_per_rss' – RSS聚合显示的最新文章数量

默认: None

$default
(mixed) (可选) 当数据库中不存在该选项默认的返回值.
Default: false

【返回值】

指定选项名称的值,如果没有返回数组则返回FALSE.更多信息请见http://codex.wordpress.org/Option_Reference

【函数实例】

  1. <?php
  2.  
  3. $no_exists_value = get_option('no_exists_value');
  4. var_dump($no_exists_value); /* 不存在no_exists_value选项时返回false */
  5.  
  6. $no_exists_value = get_option('no_exists_value','default_value');
  7. var_dump($no_exists_value); /* 不存在no_exists_value 设置默认返回值 default_value */
  8.  
  9. ?>

显示博客标题:

  1. <h1><?php echo get_option('blogname'); ?></h1>

显示博客站点字符集:

  1. <p>Character set: <?php echo get_option('blog_charset'); ?> </p>

获取管理员email地址:

  1. <?php $admin_email = get_option('admin_email'); ?>

【源代码】

get_option() 位于 wp-includes/option.php,函数代码如下:

  1. function get_option( $option, $default = false ) {
  2. global $wpdb;
  3.  
  4. $option = trim( $option );
  5. if ( empty( $option ) )
  6. return false;
  7.  
  8. // Allow plugins to short-circuit options.
  9. $pre = apply_filters( 'pre_option_' . $option, false );
  10. if ( false !== $pre )
  11. return $pre;
  12.  
  13. if ( defined( 'WP_SETUP_CONFIG' ) )
  14. return false;
  15.  
  16. if ( ! defined( 'WP_INSTALLING' ) ) {
  17. // prevent non-existent options from triggering multiple queries
  18. $notoptions = wp_cache_get( 'notoptions', 'options' );
  19. if ( isset( $notoptions[$option] ) )
  20. return apply_filters( 'default_option_' . $option, $default );
  21.  
  22. $alloptions = wp_load_alloptions();
  23.  
  24. if ( isset( $alloptions[$option] ) ) {
  25. $value = $alloptions[$option];
  26. } else {
  27. $value = wp_cache_get( $option, 'options' );
  28.  
  29. if ( false === $value ) {
  30. $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
  31.  
  32. // Has to be get_row instead of get_var because of funkiness with 0, false, null values
  33. if ( is_object( $row ) ) {
  34. $value = $row->option_value;
  35. wp_cache_add( $option, $value, 'options' );
  36. } else { // option does not exist, so we must cache its non-existence
  37. $notoptions[$option] = true;
  38. wp_cache_set( 'notoptions', $notoptions, 'options' );
  39. return apply_filters( 'default_option_' . $option, $default );
  40. }
  41. }
  42. }
  43. } else {
  44. $suppress = $wpdb->suppress_errors();
  45. $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
  46. $wpdb->suppress_errors( $suppress );
  47. if ( is_object( $row ) )
  48. $value = $row->option_value;
  49. else
  50. return apply_filters( 'default_option_' . $option, $default );
  51. }
  52.  
  53. // If home is not set use siteurl.
  54. if ( 'home' == $option && '' == $value )
  55. return get_option( 'siteurl' );
  56.  
  57. if ( in_array( $option, array('siteurl', 'home', 'category_base', 'tag_base') ) )
  58. $value = untrailingslashit( $value );
  59.  
  60. return apply_filters( 'option_' . $option, maybe_unserialize( $value ) );
  61. }