Merge pull request wp-cli#197 from wp-cli/3271-get-config

danielbachhuber · web-flow · commit c3f919509111 · 2016-08-10T06:22:40.000-07:00
Mark `WP_CLI::get_config()` as a public internal API
diff --git a/_includes/internal-api-list.html b/_includes/internal-api-list.html
@@ -75,6 +75,9 @@
 <li><strong><a href="/docs/internal-api/wp-cli-read-value/">WP_CLI::read_value()</a></strong> - Read a value, from various formats.</li>
 
 
+<li><strong><a href="/docs/internal-api/wp-cli-get-config/">WP_CLI::get_config()</a></strong> - Get values of global configuration parameters.</li>
+
+
 </ul>
 
 
diff --git a/docs/internal-api/wp-cli-confirm/index.md b/docs/internal-api/wp-cli-confirm/index.md
@@ -56,6 +56,9 @@ If 'y' is provided to the question, the script execution continues. If
 <li><strong><a href="/docs/internal-api/wp-cli-read-value/">WP_CLI::read_value()</a></strong> - Read a value, from various formats.</li>
 
 
+<li><strong><a href="/docs/internal-api/wp-cli-get-config/">WP_CLI::get_config()</a></strong> - Get values of global configuration parameters.</li>
+
+
 
 </ul>
 
diff --git a/docs/internal-api/wp-cli-get-config/index.md b/docs/internal-api/wp-cli-get-config/index.md
@@ -0,0 +1,63 @@
+---
+layout: default
+title: WP_CLI::get_config()
+description: "Get values of global configuration parameters."
+---
+
+<a href="/docs/">Docs</a> &raquo; <a href="/docs/internal-api/">Internal API</a> &raquo; Input
+
+## WP_CLI::get_config()
+
+Get values of global configuration parameters.
+
+***
+
+### Usage
+
+    WP_CLI::get_config( $key = null )
+
+<div>
+<strong>$key</strong> (string) Get value for a specific global configuration parameter.<br />
+<strong>@return</strong> (mixed) <br />
+</div>
+
+
+***
+
+### Notes
+
+Provides access to `--path=<path>`, `--url=<url>`, and other values of
+the [global configuration parameters](https://wp-cli.org/config/).
+
+
+    WP_CLI::log( 'The --url=<url> value is: ' . WP_CLI::get_config( 'url' ) );
+    
+
+
+*Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.*
+
+
+***
+
+### Related
+
+<ul>
+
+
+
+<li><strong><a href="/docs/internal-api/wp-cli-utils-launch-editor-for-input/">WP_CLI\Utils\launch_editor_for_input()</a></strong> - Launch system's $EDITOR for the user to edit some text.</li>
+
+
+<li><strong><a href="/docs/internal-api/wp-cli-utils-get-flag-value/">WP_CLI\Utils\get_flag_value()</a></strong> - Return the flag value or, if it's not set, the $default value.</li>
+
+
+<li><strong><a href="/docs/internal-api/wp-cli-confirm/">WP_CLI::confirm()</a></strong> - Ask for confirmation before running a destructive operation.</li>
+
+
+<li><strong><a href="/docs/internal-api/wp-cli-read-value/">WP_CLI::read_value()</a></strong> - Read a value, from various formats.</li>
+
+
+
+</ul>
+
+
diff --git a/docs/internal-api/wp-cli-read-value/index.md b/docs/internal-api/wp-cli-read-value/index.md
@@ -42,6 +42,9 @@ Read a value, from various formats.
 <li><strong><a href="/docs/internal-api/wp-cli-confirm/">WP_CLI::confirm()</a></strong> - Ask for confirmation before running a destructive operation.</li>
 
 
+<li><strong><a href="/docs/internal-api/wp-cli-get-config/">WP_CLI::get_config()</a></strong> - Get values of global configuration parameters.</li>
+
+
 
 </ul>
 
diff --git a/docs/internal-api/wp-cli-utils-get-flag-value/index.md b/docs/internal-api/wp-cli-utils-get-flag-value/index.md
@@ -53,6 +53,9 @@ function provides a safer alternative to using
 <li><strong><a href="/docs/internal-api/wp-cli-read-value/">WP_CLI::read_value()</a></strong> - Read a value, from various formats.</li>
 
 
+<li><strong><a href="/docs/internal-api/wp-cli-get-config/">WP_CLI::get_config()</a></strong> - Get values of global configuration parameters.</li>
+
+
 
 </ul>
 
diff --git a/docs/internal-api/wp-cli-utils-launch-editor-for-input/index.md b/docs/internal-api/wp-cli-utils-launch-editor-for-input/index.md
@@ -42,6 +42,9 @@ Launch system's $EDITOR for the user to edit some text.
 <li><strong><a href="/docs/internal-api/wp-cli-read-value/">WP_CLI::read_value()</a></strong> - Read a value, from various formats.</li>
 
 
+<li><strong><a href="/docs/internal-api/wp-cli-get-config/">WP_CLI::get_config()</a></strong> - Get values of global configuration parameters.</li>
+
+
 
 </ul>
 
