+ abuse_extension
+
+
+ extends abstract_extension
+
+
+
+ in package
+
+
+
+
+
+
+
+
+ Extension: abuseipdb - AbuseIPDB API - {eac}Doojigger for WordPress
+ + + ++ Tags + +
+ + + + + + + ++ Table of Contents + +
+ +-
+
- + ALIAS + + = null + + + +
- + ALLOW_ADMIN + + = 0b1 + + + +
- + ALLOW_ALL + + = self::ALLOW_ADMIN | self::ALLOW_NETWORK | self::ALLOW_CRON | self::ALLOW_CLI + + + +
- + ALLOW_CLI + + = 0b10000 + + + +
- + ALLOW_CRON + + = 0b1000 + + + +
- + ALLOW_NETWORK + + = 0b100 + + + +
- + ALLOW_NON_PHP + + = 0b1000000 + + + +
- + DEFAULT_DISABLED + + = 0b100000 + + + +
- + ONLY_ADMIN + + = 0b10 + + + +
- + VERSION + + = '24.0906.1' + + + +
- + __call() + + : mixed + +
- magic method to call plugin or extension methods + +
- + __construct() + + : void + +
- constructor method + +
- + __destruct() + + : void + +
- Extension destructor + +
- + __get() + + : mixed + +
- magic method to call parent plugin __get() + +
- + addActionsAndFilters() + + : void + +
- Add filters and actions - called from main plugin + +
- + addShortcodes() + + : void + +
- Add extension shortcodes + +
- + admin_options_help() + + : void + +
- Add help tab on admin page + +
- + admin_options_settings() + + : void + +
- register options on options_settings_page + +
- + check_for_abuse() + + : bool + +
- Use the AbuseIPDB API to validate/block IP address + +
- + get_AbuseIPDB() + + : array<string|int, mixed> + +
- Use the AbuseIPDB API to validate/block IP address + +
- + getAlias() + + : const + +
- get the extension alias + +
- + getClassName() + + : bool + +
- getClassName - get the class/extension name without namespace + +
- + getVersion() + + : const + +
- get the extension version + +
- + initialize() + + : void + +
- initialize method - called from main plugin + +
- + is_network_enabled() + + : bool + +
- is_network_enabled - set or test extension enabled for use at the network level + +
- + is_network_option() + + : bool|mixed + +
- is this class network enabled and does option match a value + +
- + isEnabled() + + : bool + +
- isEnabled - set or test extension enabled for use + +
- + isPolicyEnabled() + + : mixed + +
- is site or network option set + +
+ Constants + +
++ ALIAS + +
+ + + + +
+ public
+ ALIAS
+ ALIAS
+ = null
+
+
+
+
+ constant in child class for alias class name
++ ALLOW_ADMIN + +
+ + + + +
+ public
+ constructor
+ ALLOW_ADMIN
+ = 0b1
+
+
+
+
+ flags (actual values subject to change)
++ ALLOW_ALL + +
+ + + + +
+ public
+ mixed
+ ALLOW_ALL
+ = self::ALLOW_ADMIN | self::ALLOW_NETWORK | self::ALLOW_CRON | self::ALLOW_CLI
+
+
+
+
+
+
+
+
+
++ ALLOW_CLI + +
+ + + + +
+ public
+ mixed
+ ALLOW_CLI
+ = 0b10000
+
+
+
+
+
+
+
+
+
++ ALLOW_CRON + +
+ + + + +
+ public
+ mixed
+ ALLOW_CRON
+ = 0b1000
+
+
+
+
+
+
+
+
+
++ ALLOW_NETWORK + +
+ + + + +
+ public
+ mixed
+ ALLOW_NETWORK
+ = 0b100
+
+
+
+
+
+
+
+
+
++ ALLOW_NON_PHP + +
+ + + + +
+ public
+ mixed
+ ALLOW_NON_PHP
+ = 0b1000000
+
+
+
+
+
+
+
+
+
++ DEFAULT_DISABLED + +
+ + + + +
+ public
+ mixed
+ DEFAULT_DISABLED
+ = 0b100000
+
+
+
+
+
+
+
+
+
++ ONLY_ADMIN + +
+ + + + +
+ public
+ mixed
+ ONLY_ADMIN
+ = 0b10
+
+
+
+
+
+
+
+
+
++ VERSION + +
+ + + + +
+ public
+ string
+ VERSION
+ = '24.0906.1'
+
+
+
+
+ extension version
++ Methods + +
++ __call() + +
+ + +magic method to call plugin or extension methods
+ +
+ public
+ __call(mixed $method, mixed $arguments) : mixed
+
+
+ Parameters
+-
+
- + $method + : mixed + +
-
+
the method name or [extension,method]
+
+ - + $arguments + : mixed + +
-
+
the arguments to method name
+
+
Return values
+ mixed + — +result of method called
++ __construct() + +
+ + +constructor method
+ +
+ public
+ __construct(object $plugin) : void
+
+
+ Parameters
+-
+
- + $plugin + : object + +
-
+
main plugin object
+
+
Return values
+ void + — + + ++ __destruct() + +
+ + +Extension destructor
+ +
+ public
+ __destruct() : void
+
+
+
+
+
+ Return values
+ void + — + + ++ __get() + +
+ + +magic method to call parent plugin __get()
+ +
+ public
+ __get(string $property) : mixed
+
+
+ Parameters
+-
+
- + $property + : string + +
-
+
the property name or extension name
+
+
Return values
+ mixed + — +result of plugin __get()
++ addActionsAndFilters() + +
+ + +Add filters and actions - called from main plugin
+ +
+ public
+ addActionsAndFilters() : void
+
+
+
+
+
+ Return values
+ void + — + + ++ addShortcodes() + +
+ + +Add extension shortcodes
+ +
+ public
+ addShortcodes() : void
+
+ Called after loading, instantiating, and initializing all extensions
+Return values
+ void + — + + ++ admin_options_help() + +
+ + +Add help tab on admin page
+ +
+ public
+ admin_options_help() : void
+
+
+
+
+ + Tags + +
+ + +Return values
+ void + — + + ++ admin_options_settings() + +
+ + +register options on options_settings_page
+ +
+ public
+ admin_options_settings() : void
+
+
+
+
+ + Tags + +
+ + +Return values
+ void + — + + ++ check_for_abuse() + +
+ + +Use the AbuseIPDB API to validate/block IP address
+ +
+ public
+ check_for_abuse([mixed $arg = null ]) : bool
+
+
+ Parameters
+-
+
- + $arg + : mixed + = null +
- + + + +
Return values
+ bool + — + + ++ get_AbuseIPDB() + +
+ + +Use the AbuseIPDB API to validate/block IP address
+ +
+ public
+ get_AbuseIPDB(mixed $key[, mixed $level = 100 ]) : array<string|int, mixed>
+
+
+ Parameters
+-
+
- + $key + : mixed + +
- + + + +
- + $level + : mixed + = 100 +
- + + + +
Return values
+ array<string|int, mixed> + — + + ++ getAlias() + +
+ + +get the extension alias
+ +
+ public
+ getAlias() : const
+
+
+
+
+
+ Return values
+ const + — +ALIAS string
++ getClassName() + +
+ + +getClassName - get the class/extension name without namespace
+ +
+ public
+ getClassName([object $class = null ]) : bool
+
+
+ Parameters
+-
+
- + $class + : object + = null +
-
+
optional class object
+
+
Return values
+ bool + — + + ++ getVersion() + +
+ + +get the extension version
+ +
+ public
+ getVersion() : const
+
+
+
+
+
+ Return values
+ const + — +VERSION string
++ initialize() + +
+ + +initialize method - called from main plugin
+ +
+ public
+ initialize() : void
+
+
+
+
+
+ Return values
+ void + — + + ++ is_network_enabled() + +
+ + +is_network_enabled - set or test extension enabled for use at the network level
+ +
+ public
+ is_network_enabled() : bool
+
+
+
+
+
+ Return values
+ bool + — + + ++ is_network_option() + +
+ + +is this class network enabled and does option match a value
+ +
+ public
+ is_network_option(string $optionName[, mixed $value = null ]) : bool|mixed
+
+
+ Parameters
+-
+
- + $optionName + : string + +
-
+
option name
+
+ - + $value + : mixed + = null +
-
+
check this value
+
+
Return values
+ bool|mixed + — +option is set and has value
++ isEnabled() + +
+ + +isEnabled - set or test extension enabled for use
+ +
+ public
+ isEnabled([bool|string $enabled = null ][, bool $perm = null ]) : bool
+
+
+ Parameters
+-
+
- + $enabled + : bool|string + = null +
-
+
true|false or other extension name
+
+ - + $perm + : bool + = null +
-
+
optional, to permanently set enabled option
+
+
Return values
+ bool + — + + ++ isPolicyEnabled() + +
+ + +is site or network option set
+ +
+ public
+ isPolicyEnabled(string $optionName[, string $value = null ]) : mixed
+
+
+ Parameters
+-
+
- + $optionName + : string + +
-
+
-
+
- policy/option name +
+ - + $value + : string + = null +
-
+
-
+
- check for specific value +
+